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

vtcode_commons/
provider.rs
