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    /// OpenRouter marketplace models
35    OpenRouter,
36    /// Local Ollama models
37    Ollama,
38    /// Ollama Cloud hosted models (ollama.com)
39    OllamaCloud,
40    /// LM Studio local models
41    LmStudio,
42    /// llama.cpp local models
43    LlamaCpp,
44    /// Moonshot.ai models
45    Moonshot,
46    /// Z.AI GLM models
47    ZAI,
48    /// MiniMax models
49    Minimax,
50    /// Xiaomi MiMo models
51    MiMo,
52    /// Mistral AI models
53    Mistral,
54    /// Hugging Face Inference Providers
55    HuggingFace,
56    /// OpenCode Zen gateway (pay-as-you-go)
57    OpenCodeZen,
58    /// OpenCode Go subscription
59    OpenCodeGo,
60    /// Alibaba Cloud Qwen models
61    Qwen,
62    /// StepFun models
63    StepFun,
64    /// Evolink multi-model gateway
65    Evolink,
66    /// Poolside AI models
67    Poolside,
68    /// xAI Grok models
69    XAI,
70    /// NVIDIA NIM OpenAI-compatible models
71    NVIDIA,
72}
73
74impl Provider {
75    /// Get the default API key environment variable for this provider
76    pub fn default_api_key_env(&self) -> &'static str {
77        match self {
78            Provider::Gemini => "GEMINI_API_KEY",
79            Provider::OpenAI => "OPENAI_API_KEY",
80            Provider::Anthropic => "ANTHROPIC_API_KEY",
81            Provider::Copilot => "",
82            Provider::DeepSeek => "DEEPSEEK_API_KEY",
83            Provider::OpenRouter => "OPENROUTER_API_KEY",
84            Provider::Ollama => "OLLAMA_API_KEY",
85            Provider::OllamaCloud => "OLLAMA_API_KEY",
86            Provider::LmStudio => "LMSTUDIO_API_KEY",
87            Provider::LlamaCpp => "LLAMACPP_API_KEY",
88            Provider::Moonshot => "MOONSHOT_API_KEY",
89            Provider::ZAI => "ZAI_API_KEY",
90            Provider::Minimax => "MINIMAX_API_KEY",
91            Provider::MiMo => "MIMO_API_KEY",
92            Provider::Mistral => "MISTRAL_API_KEY",
93            Provider::HuggingFace => "HF_TOKEN",
94            Provider::OpenCodeZen => "OPENCODE_ZEN_API_KEY",
95            Provider::OpenCodeGo => "OPENCODE_GO_API_KEY",
96            Provider::Qwen => "QWEN_API_KEY",
97            Provider::StepFun => "STEPFUN_API_KEY",
98            Provider::Evolink => "EVOLINK_API_KEY",
99            Provider::Poolside => "POOLSIDE_API_KEY",
100            Provider::XAI => "XAI_API_KEY",
101            Provider::NVIDIA => "NVIDIA_API_KEY",
102        }
103    }
104
105    /// Get all supported providers
106    pub fn all_providers() -> Vec<Provider> {
107        vec![
108            Provider::OpenAI,
109            Provider::Anthropic,
110            Provider::Copilot,
111            Provider::Minimax,
112            Provider::MiMo,
113            Provider::Mistral,
114            Provider::Gemini,
115            Provider::DeepSeek,
116            Provider::HuggingFace,
117            Provider::OpenRouter,
118            Provider::Ollama,
119            Provider::OllamaCloud,
120            Provider::LmStudio,
121            Provider::LlamaCpp,
122            Provider::Moonshot,
123            Provider::ZAI,
124            Provider::OpenCodeZen,
125            Provider::OpenCodeGo,
126            Provider::Qwen,
127            Provider::StepFun,
128            Provider::Evolink,
129            Provider::Poolside,
130            Provider::XAI,
131            Provider::NVIDIA,
132        ]
133    }
134
135    /// Human-friendly label for display purposes
136    pub fn label(&self) -> &'static str {
137        match self {
138            Provider::Gemini => "Gemini",
139            Provider::OpenAI => "OpenAI",
140            Provider::Anthropic => "Anthropic",
141            Provider::Copilot => "GitHub Copilot",
142            Provider::DeepSeek => "DeepSeek",
143            Provider::OpenRouter => "OpenRouter",
144            Provider::Ollama => "Ollama",
145            Provider::OllamaCloud => "Ollama Cloud",
146            Provider::LmStudio => "LM Studio",
147            Provider::LlamaCpp => "llama.cpp",
148            Provider::Moonshot => "Moonshot",
149            Provider::ZAI => "Z.AI",
150            Provider::Minimax => "MiniMax",
151            Provider::MiMo => "Xiaomi MiMo",
152            Provider::Mistral => "Mistral",
153            Provider::HuggingFace => "Hugging Face",
154            Provider::OpenCodeZen => "OpenCode Zen",
155            Provider::OpenCodeGo => "OpenCode Go",
156            Provider::Qwen => "Qwen",
157            Provider::StepFun => "StepFun",
158            Provider::Evolink => "Evolink",
159            Provider::Poolside => "Poolside",
160            Provider::XAI => "xAI",
161            Provider::NVIDIA => "NVIDIA",
162        }
163    }
164
165    pub fn is_dynamic(&self) -> bool {
166        matches!(self, Provider::Copilot) || self.is_local()
167    }
168
169    pub fn is_local(&self) -> bool {
170        matches!(self, Provider::Ollama | Provider::LmStudio | Provider::LlamaCpp)
171    }
172
173    pub fn local_install_instructions(&self) -> Option<&'static str> {
174        match self {
175            Provider::Ollama => Some(
176                "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')",
177            ),
178            Provider::LmStudio => Some(
179                "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",
180            ),
181            Provider::LlamaCpp => Some(
182                "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",
183            ),
184            _ => None,
185        }
186    }
187
188    pub fn uses_managed_auth(&self) -> bool {
189        matches!(self, Provider::Copilot)
190    }
191
192    pub fn platform_url(&self) -> Option<&'static str> {
193        match self {
194            Provider::Gemini => Some("https://aistudio.google.com/app/apikey"),
195            Provider::OpenAI => Some("https://platform.openai.com/api-keys"),
196            Provider::Anthropic => Some("https://console.anthropic.com"),
197            Provider::Copilot => None,
198            Provider::DeepSeek => Some("https://platform.deepseek.com"),
199            Provider::OpenRouter => Some("https://openrouter.ai/api/v1/auth/keys"),
200            Provider::Ollama => None,
201            Provider::OllamaCloud => Some("https://ollama.com"),
202            Provider::LmStudio => None,
203            Provider::LlamaCpp => None,
204            Provider::Moonshot => Some("https://platform.kimi.ai/console/api-keys"),
205            Provider::ZAI => Some("https://z.ai/docs"),
206            Provider::Minimax => Some("https://platform.minimax.io/docs"),
207            Provider::MiMo => Some("https://platform.xiaomimimo.com/docs/en-US/welcome"),
208            Provider::Mistral => Some("https://console.mistral.ai"),
209            Provider::HuggingFace => Some("https://huggingface.co/settings/tokens"),
210            Provider::OpenCodeZen => Some("https://opencode.ai/docs/zen/"),
211            Provider::OpenCodeGo => Some("https://opencode.ai/docs/go/"),
212            Provider::Qwen => Some("https://dashscope.console.aliyun.com"),
213            Provider::StepFun => Some("https://platform.stepfun.com"),
214            Provider::Evolink => Some("https://evolink.ai/dashboard/keys"),
215            Provider::Poolside => Some("https://poolside.ai"),
216            Provider::XAI => Some("https://docs.x.ai"),
217            Provider::NVIDIA => Some("https://build.nvidia.com"),
218        }
219    }
220}
221
222impl fmt::Display for Provider {
223    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
224        match self {
225            Provider::Gemini => write!(f, "gemini"),
226            Provider::OpenAI => write!(f, "openai"),
227            Provider::Anthropic => write!(f, "anthropic"),
228            Provider::Copilot => write!(f, "copilot"),
229            Provider::DeepSeek => write!(f, "deepseek"),
230            Provider::OpenRouter => write!(f, "openrouter"),
231            Provider::Ollama => write!(f, "ollama"),
232            Provider::OllamaCloud => write!(f, "ollama-cloud"),
233            Provider::LmStudio => write!(f, "lmstudio"),
234            Provider::LlamaCpp => write!(f, "llamacpp"),
235            Provider::Moonshot => write!(f, "moonshot"),
236            Provider::ZAI => write!(f, "zai"),
237            Provider::Minimax => write!(f, "minimax"),
238            Provider::MiMo => write!(f, "mimo"),
239            Provider::Mistral => write!(f, "mistral"),
240            Provider::HuggingFace => write!(f, "huggingface"),
241            Provider::OpenCodeZen => write!(f, "opencode-zen"),
242            Provider::OpenCodeGo => write!(f, "opencode-go"),
243            Provider::Qwen => write!(f, "qwen"),
244            Provider::StepFun => write!(f, "stepfun"),
245            Provider::Evolink => write!(f, "evolink"),
246            Provider::Poolside => write!(f, "poolside"),
247            Provider::XAI => write!(f, "xai"),
248            Provider::NVIDIA => write!(f, "nvidia"),
249        }
250    }
251}
252
253impl AsRef<str> for Provider {
254    fn as_ref(&self) -> &str {
255        match self {
256            Provider::Gemini => "gemini",
257            Provider::OpenAI => "openai",
258            Provider::Anthropic => "anthropic",
259            Provider::Copilot => "copilot",
260            Provider::DeepSeek => "deepseek",
261            Provider::OpenRouter => "openrouter",
262            Provider::Ollama => "ollama",
263            Provider::OllamaCloud => "ollama-cloud",
264            Provider::LmStudio => "lmstudio",
265            Provider::LlamaCpp => "llamacpp",
266            Provider::Moonshot => "moonshot",
267            Provider::ZAI => "zai",
268            Provider::Minimax => "minimax",
269            Provider::MiMo => "mimo",
270            Provider::Mistral => "mistral",
271            Provider::HuggingFace => "huggingface",
272            Provider::OpenCodeZen => "opencode-zen",
273            Provider::OpenCodeGo => "opencode-go",
274            Provider::Qwen => "qwen",
275            Provider::StepFun => "stepfun",
276            Provider::Evolink => "evolink",
277            Provider::Poolside => "poolside",
278            Provider::XAI => "xai",
279            Provider::NVIDIA => "nvidia",
280        }
281    }
282}
283
284impl FromStr for Provider {
285    type Err = ProviderParseError;
286
287    fn from_str(s: &str) -> Result<Self, Self::Err> {
288        match s.to_lowercase().as_str() {
289            "gemini" => Ok(Provider::Gemini),
290            "openai" => Ok(Provider::OpenAI),
291            "anthropic" => Ok(Provider::Anthropic),
292            "copilot" => Ok(Provider::Copilot),
293            "deepseek" => Ok(Provider::DeepSeek),
294            "openrouter" => Ok(Provider::OpenRouter),
295            "ollama" => Ok(Provider::Ollama),
296            "ollama-cloud" | "ollamacloud" | "ollama_cloud" => Ok(Provider::OllamaCloud),
297            "lmstudio" => Ok(Provider::LmStudio),
298            "llamacpp" | "llama.cpp" | "llama-cpp" => Ok(Provider::LlamaCpp),
299            "moonshot" => Ok(Provider::Moonshot),
300            "zai" => Ok(Provider::ZAI),
301            "minimax" => Ok(Provider::Minimax),
302            "mimo" => Ok(Provider::MiMo),
303            "mistral" => Ok(Provider::Mistral),
304            "huggingface" => Ok(Provider::HuggingFace),
305            "opencode-zen" | "opencodezen" => Ok(Provider::OpenCodeZen),
306            "opencode-go" | "opencodego" => Ok(Provider::OpenCodeGo),
307            "qwen" => Ok(Provider::Qwen),
308            "stepfun" => Ok(Provider::StepFun),
309            "evolink" => Ok(Provider::Evolink),
310            "poolside" => Ok(Provider::Poolside),
311            "xai" => Ok(Provider::XAI),
312            "nvidia" | "nvidia-nim" => Ok(Provider::NVIDIA),
313            _ => Err(ProviderParseError::InvalidProvider(s.to_string())),
314        }
315    }
316}
vtcode_commons/provider.rs

vtcode_commons/
provider.rs
