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