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

vtcode_commons/
provider.rs
