1use std::str::FromStr;
2use std::sync::Arc;
3
4use anyhow::Context as _;
5use serde::{Deserialize, Serialize};
6use strum::{Display, EnumIter, EnumString};
7use uuid::Uuid;
8
9/// The name of the header used to indicate which version of Zed the client is running.
10pub const ZED_VERSION_HEADER_NAME: &str = "x-zed-version";
11
12/// The name of the header used to indicate when a request failed due to an
13/// expired LLM token.
14///
15/// The client may use this as a signal to refresh the token.
16pub const EXPIRED_LLM_TOKEN_HEADER_NAME: &str = "x-zed-expired-token";
17
18/// The name of the header used to indicate what plan the user is currently on.
19pub const CURRENT_PLAN_HEADER_NAME: &str = "x-zed-plan";
20
21/// The name of the header used to indicate the usage limit for model requests.
22pub const MODEL_REQUESTS_USAGE_LIMIT_HEADER_NAME: &str = "x-zed-model-requests-usage-limit";
23
24/// The name of the header used to indicate the usage amount for model requests.
25pub const MODEL_REQUESTS_USAGE_AMOUNT_HEADER_NAME: &str = "x-zed-model-requests-usage-amount";
26
27/// The name of the header used to indicate the usage limit for edit predictions.
28pub const EDIT_PREDICTIONS_USAGE_LIMIT_HEADER_NAME: &str = "x-zed-edit-predictions-usage-limit";
29
30/// The name of the header used to indicate the usage amount for edit predictions.
31pub const EDIT_PREDICTIONS_USAGE_AMOUNT_HEADER_NAME: &str = "x-zed-edit-predictions-usage-amount";
32
33/// The name of the header used to indicate the resource for which the subscription limit has been reached.
34pub const SUBSCRIPTION_LIMIT_RESOURCE_HEADER_NAME: &str = "x-zed-subscription-limit-resource";
35
36pub const MODEL_REQUESTS_RESOURCE_HEADER_VALUE: &str = "model_requests";
37pub const EDIT_PREDICTIONS_RESOURCE_HEADER_VALUE: &str = "edit_predictions";
38
39/// The name of the header used to indicate that the maximum number of consecutive tool uses has been reached.
40pub const TOOL_USE_LIMIT_REACHED_HEADER_NAME: &str = "x-zed-tool-use-limit-reached";
41
42/// The name of the header used to indicate the the minimum required Zed version.
43///
44/// This can be used to force a Zed upgrade in order to continue communicating
45/// with the LLM service.
46pub const MINIMUM_REQUIRED_VERSION_HEADER_NAME: &str = "x-zed-minimum-required-version";
47
48/// The name of the header used by the client to indicate to the server that it supports receiving status messages.
49pub const CLIENT_SUPPORTS_STATUS_MESSAGES_HEADER_NAME: &str =
50 "x-zed-client-supports-status-messages";
51
52/// The name of the header used by the server to indicate to the client that it supports sending status messages.
53pub const SERVER_SUPPORTS_STATUS_MESSAGES_HEADER_NAME: &str =
54 "x-zed-server-supports-status-messages";
55
56#[derive(Debug, PartialEq, Clone, Copy, Serialize, Deserialize)]
57#[serde(rename_all = "snake_case")]
58pub enum UsageLimit {
59 Limited(i32),
60 Unlimited,
61}
62
63impl FromStr for UsageLimit {
64 type Err = anyhow::Error;
65
66 fn from_str(value: &str) -> Result<Self, Self::Err> {
67 match value {
68 "unlimited" => Ok(Self::Unlimited),
69 limit => limit
70 .parse::<i32>()
71 .map(Self::Limited)
72 .context("failed to parse limit"),
73 }
74 }
75}
76
77#[derive(Debug, Clone, Copy, Default, PartialEq, Serialize, Deserialize)]
78#[serde(rename_all = "snake_case")]
79pub enum Plan {
80 #[default]
81 #[serde(alias = "Free")]
82 ZedFree,
83 #[serde(alias = "ZedPro")]
84 ZedPro,
85 #[serde(alias = "ZedProTrial")]
86 ZedProTrial,
87}
88
89impl Plan {
90 pub fn as_str(&self) -> &'static str {
91 match self {
92 Plan::ZedFree => "zed_free",
93 Plan::ZedPro => "zed_pro",
94 Plan::ZedProTrial => "zed_pro_trial",
95 }
96 }
97
98 pub fn model_requests_limit(&self) -> UsageLimit {
99 match self {
100 Plan::ZedPro => UsageLimit::Limited(500),
101 Plan::ZedProTrial => UsageLimit::Limited(150),
102 Plan::ZedFree => UsageLimit::Limited(50),
103 }
104 }
105
106 pub fn edit_predictions_limit(&self) -> UsageLimit {
107 match self {
108 Plan::ZedPro => UsageLimit::Unlimited,
109 Plan::ZedProTrial => UsageLimit::Unlimited,
110 Plan::ZedFree => UsageLimit::Limited(2_000),
111 }
112 }
113}
114
115impl FromStr for Plan {
116 type Err = anyhow::Error;
117
118 fn from_str(value: &str) -> Result<Self, Self::Err> {
119 match value {
120 "zed_free" => Ok(Plan::ZedFree),
121 "zed_pro" => Ok(Plan::ZedPro),
122 "zed_pro_trial" => Ok(Plan::ZedProTrial),
123 plan => Err(anyhow::anyhow!("invalid plan: {plan:?}")),
124 }
125 }
126}
127
128#[derive(
129 Debug, PartialEq, Eq, Hash, Clone, Copy, Serialize, Deserialize, EnumString, EnumIter, Display,
130)]
131#[serde(rename_all = "snake_case")]
132#[strum(serialize_all = "snake_case")]
133pub enum LanguageModelProvider {
134 Anthropic,
135 OpenAi,
136 Google,
137}
138
139#[derive(Debug, Clone, Serialize, Deserialize)]
140pub struct PredictEditsBody {
141 #[serde(skip_serializing_if = "Option::is_none", default)]
142 pub outline: Option<String>,
143 pub input_events: String,
144 pub input_excerpt: String,
145 #[serde(skip_serializing_if = "Option::is_none", default)]
146 pub speculated_output: Option<String>,
147 /// Whether the user provided consent for sampling this interaction.
148 #[serde(default, alias = "data_collection_permission")]
149 pub can_collect_data: bool,
150 #[serde(skip_serializing_if = "Option::is_none", default)]
151 pub diagnostic_groups: Option<Vec<(String, serde_json::Value)>>,
152 /// Info about the git repository state, only present when can_collect_data is true.
153 #[serde(skip_serializing_if = "Option::is_none", default)]
154 pub git_info: Option<PredictEditsGitInfo>,
155}
156
157#[derive(Debug, Clone, Serialize, Deserialize)]
158pub struct PredictEditsGitInfo {
159 /// Path to the file in the repository that contains the input excerpt.
160 #[serde(skip_serializing_if = "Option::is_none", default)]
161 pub input_path: Option<String>,
162 /// Cursor position within the file that contains the input excerpt.
163 #[serde(skip_serializing_if = "Option::is_none", default)]
164 pub cursor_point: Option<Point>,
165 /// SHA of git HEAD commit at time of prediction.
166 #[serde(skip_serializing_if = "Option::is_none", default)]
167 pub head_sha: Option<String>,
168 /// URL of the remote called `origin`.
169 #[serde(skip_serializing_if = "Option::is_none", default)]
170 pub remote_origin_url: Option<String>,
171 /// URL of the remote called `upstream`.
172 #[serde(skip_serializing_if = "Option::is_none", default)]
173 pub remote_upstream_url: Option<String>,
174 /// Recently active files that may be within this repository.
175 #[serde(skip_serializing_if = "Option::is_none", default)]
176 pub recent_files: Option<Vec<PredictEditsRecentFile>>,
177}
178
179/// A zero-indexed point in a text buffer consisting of a row and column.
180#[derive(Debug, Clone, Serialize, Deserialize)]
181pub struct Point {
182 pub row: u32,
183 pub column: u32,
184}
185
186#[derive(Debug, Clone, Serialize, Deserialize)]
187pub struct PredictEditsRecentFile {
188 /// Path to a file within the repository.
189 pub path: String,
190 /// Most recent cursor position with the file.
191 pub cursor_point: Point,
192 /// Milliseconds between the editor for this file being active and the request time.
193 pub active_to_now_ms: u32,
194}
195
196#[derive(Debug, Clone, Serialize, Deserialize)]
197pub struct PredictEditsResponse {
198 pub request_id: Uuid,
199 pub output_excerpt: String,
200}
201
202#[derive(Debug, Clone, Serialize, Deserialize)]
203pub struct AcceptEditPredictionBody {
204 pub request_id: Uuid,
205}
206
207#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy, Serialize, Deserialize)]
208#[serde(rename_all = "snake_case")]
209pub enum CompletionMode {
210 Normal,
211 Max,
212}
213
214#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy, Serialize, Deserialize)]
215#[serde(rename_all = "snake_case")]
216pub enum CompletionIntent {
217 UserPrompt,
218 ToolResults,
219 ThreadSummarization,
220 ThreadContextSummarization,
221 CreateFile,
222 EditFile,
223 InlineAssist,
224 TerminalInlineAssist,
225 GenerateGitCommitMessage,
226}
227
228#[derive(Debug, Serialize, Deserialize)]
229pub struct CompletionBody {
230 #[serde(skip_serializing_if = "Option::is_none", default)]
231 pub thread_id: Option<String>,
232 #[serde(skip_serializing_if = "Option::is_none", default)]
233 pub prompt_id: Option<String>,
234 #[serde(skip_serializing_if = "Option::is_none", default)]
235 pub intent: Option<CompletionIntent>,
236 #[serde(skip_serializing_if = "Option::is_none", default)]
237 pub mode: Option<CompletionMode>,
238 pub provider: LanguageModelProvider,
239 pub model: String,
240 pub provider_request: serde_json::Value,
241}
242
243#[derive(Debug, PartialEq, Clone, Serialize, Deserialize)]
244#[serde(rename_all = "snake_case")]
245pub enum CompletionRequestStatus {
246 Queued {
247 position: usize,
248 },
249 Started,
250 Failed {
251 code: String,
252 message: String,
253 request_id: Uuid,
254 /// Retry duration in seconds.
255 retry_after: Option<f64>,
256 },
257 UsageUpdated {
258 amount: usize,
259 limit: UsageLimit,
260 },
261 ToolUseLimitReached,
262}
263
264#[derive(Serialize, Deserialize)]
265#[serde(rename_all = "snake_case")]
266pub enum CompletionEvent<T> {
267 Status(CompletionRequestStatus),
268 Event(T),
269}
270
271impl<T> CompletionEvent<T> {
272 pub fn into_status(self) -> Option<CompletionRequestStatus> {
273 match self {
274 Self::Status(status) => Some(status),
275 Self::Event(_) => None,
276 }
277 }
278
279 pub fn into_event(self) -> Option<T> {
280 match self {
281 Self::Event(event) => Some(event),
282 Self::Status(_) => None,
283 }
284 }
285}
286
287#[derive(Serialize, Deserialize)]
288pub struct WebSearchBody {
289 pub query: String,
290}
291
292#[derive(Debug, Serialize, Deserialize, Clone)]
293pub struct WebSearchResponse {
294 pub results: Vec<WebSearchResult>,
295}
296
297#[derive(Debug, Serialize, Deserialize, Clone)]
298pub struct WebSearchResult {
299 pub title: String,
300 pub url: String,
301 pub text: String,
302}
303
304#[derive(Serialize, Deserialize)]
305pub struct CountTokensBody {
306 pub provider: LanguageModelProvider,
307 pub model: String,
308 pub provider_request: serde_json::Value,
309}
310
311#[derive(Serialize, Deserialize)]
312pub struct CountTokensResponse {
313 pub tokens: usize,
314}
315
316#[derive(Debug, PartialEq, Eq, Hash, Clone, Serialize, Deserialize)]
317pub struct LanguageModelId(pub Arc<str>);
318
319impl std::fmt::Display for LanguageModelId {
320 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
321 write!(f, "{}", self.0)
322 }
323}
324
325#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
326pub struct LanguageModel {
327 pub provider: LanguageModelProvider,
328 pub id: LanguageModelId,
329 pub display_name: String,
330 pub max_token_count: usize,
331 pub max_token_count_in_max_mode: Option<usize>,
332 pub max_output_tokens: usize,
333 pub supports_tools: bool,
334 pub supports_images: bool,
335 pub supports_thinking: bool,
336 pub supports_max_mode: bool,
337}
338
339#[derive(Debug, Serialize, Deserialize)]
340pub struct ListModelsResponse {
341 pub models: Vec<LanguageModel>,
342 pub default_model: LanguageModelId,
343 pub default_fast_model: LanguageModelId,
344 pub recommended_models: Vec<LanguageModelId>,
345}
346
347#[derive(Debug, Serialize, Deserialize)]
348pub struct GetSubscriptionResponse {
349 pub plan: Plan,
350 pub usage: Option<CurrentUsage>,
351}
352
353#[derive(Debug, PartialEq, Serialize, Deserialize)]
354pub struct CurrentUsage {
355 pub model_requests: UsageData,
356 pub edit_predictions: UsageData,
357}
358
359#[derive(Debug, PartialEq, Serialize, Deserialize)]
360pub struct UsageData {
361 pub used: u32,
362 pub limit: UsageLimit,
363}
364
365#[cfg(test)]
366mod tests {
367 use pretty_assertions::assert_eq;
368 use serde_json::json;
369
370 use super::*;
371
372 #[test]
373 fn test_plan_deserialize_snake_case() {
374 let plan = serde_json::from_value::<Plan>(json!("zed_free")).unwrap();
375 assert_eq!(plan, Plan::ZedFree);
376
377 let plan = serde_json::from_value::<Plan>(json!("zed_pro")).unwrap();
378 assert_eq!(plan, Plan::ZedPro);
379
380 let plan = serde_json::from_value::<Plan>(json!("zed_pro_trial")).unwrap();
381 assert_eq!(plan, Plan::ZedProTrial);
382 }
383
384 #[test]
385 fn test_plan_deserialize_aliases() {
386 let plan = serde_json::from_value::<Plan>(json!("Free")).unwrap();
387 assert_eq!(plan, Plan::ZedFree);
388
389 let plan = serde_json::from_value::<Plan>(json!("ZedPro")).unwrap();
390 assert_eq!(plan, Plan::ZedPro);
391
392 let plan = serde_json::from_value::<Plan>(json!("ZedProTrial")).unwrap();
393 assert_eq!(plan, Plan::ZedProTrial);
394 }
395
396 #[test]
397 fn test_usage_limit_from_str() {
398 let limit = UsageLimit::from_str("unlimited").unwrap();
399 assert!(matches!(limit, UsageLimit::Unlimited));
400
401 let limit = UsageLimit::from_str(&0.to_string()).unwrap();
402 assert!(matches!(limit, UsageLimit::Limited(0)));
403
404 let limit = UsageLimit::from_str(&50.to_string()).unwrap();
405 assert!(matches!(limit, UsageLimit::Limited(50)));
406
407 for value in ["not_a_number", "50xyz"] {
408 let limit = UsageLimit::from_str(value);
409 assert!(limit.is_err());
410 }
411 }
412}