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}
173
174#[derive(Debug, Clone, Serialize, Deserialize)]
175pub struct PredictEditsGitInfo {
176 /// SHA of git HEAD commit at time of prediction.
177 #[serde(skip_serializing_if = "Option::is_none", default)]
178 pub head_sha: Option<String>,
179 /// URL of the remote called `origin`.
180 #[serde(skip_serializing_if = "Option::is_none", default)]
181 pub remote_origin_url: Option<String>,
182 /// URL of the remote called `upstream`.
183 #[serde(skip_serializing_if = "Option::is_none", default)]
184 pub remote_upstream_url: Option<String>,
185}
186
187#[derive(Debug, Clone, Serialize, Deserialize)]
188pub struct PredictEditsResponse {
189 pub request_id: String,
190 pub output_excerpt: String,
191}
192
193#[derive(Debug, Clone, Serialize, Deserialize)]
194pub struct AcceptEditPredictionBody {
195 pub request_id: String,
196}
197
198#[derive(Debug, Clone, Serialize, Deserialize)]
199pub struct RejectEditPredictionsBody {
200 pub rejections: Vec<EditPredictionRejection>,
201}
202
203#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
204pub struct EditPredictionRejection {
205 pub request_id: String,
206 #[serde(default)]
207 pub reason: EditPredictionRejectReason,
208 pub was_shown: bool,
209}
210
211#[derive(Default, Debug, Clone, Copy, Serialize, Deserialize, PartialEq)]
212pub enum EditPredictionRejectReason {
213 /// New requests were triggered before this one completed
214 Canceled,
215 /// No edits returned
216 Empty,
217 /// Edits returned, but none remained after interpolation
218 InterpolatedEmpty,
219 /// The new prediction was preferred over the current one
220 Replaced,
221 /// The current prediction was preferred over the new one
222 CurrentPreferred,
223 /// The current prediction was discarded
224 #[default]
225 Discarded,
226}
227
228#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy, Serialize, Deserialize)]
229#[serde(rename_all = "snake_case")]
230pub enum CompletionMode {
231 Normal,
232 Max,
233}
234
235#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy, Serialize, Deserialize)]
236#[serde(rename_all = "snake_case")]
237pub enum CompletionIntent {
238 UserPrompt,
239 ToolResults,
240 ThreadSummarization,
241 ThreadContextSummarization,
242 CreateFile,
243 EditFile,
244 InlineAssist,
245 TerminalInlineAssist,
246 GenerateGitCommitMessage,
247}
248
249#[derive(Debug, Serialize, Deserialize)]
250pub struct CompletionBody {
251 #[serde(skip_serializing_if = "Option::is_none", default)]
252 pub thread_id: Option<String>,
253 #[serde(skip_serializing_if = "Option::is_none", default)]
254 pub prompt_id: Option<String>,
255 #[serde(skip_serializing_if = "Option::is_none", default)]
256 pub intent: Option<CompletionIntent>,
257 #[serde(skip_serializing_if = "Option::is_none", default)]
258 pub mode: Option<CompletionMode>,
259 pub provider: LanguageModelProvider,
260 pub model: String,
261 pub provider_request: serde_json::Value,
262}
263
264#[derive(Debug, PartialEq, Clone, Serialize, Deserialize)]
265#[serde(rename_all = "snake_case")]
266pub enum CompletionRequestStatus {
267 Queued {
268 position: usize,
269 },
270 Started,
271 Failed {
272 code: String,
273 message: String,
274 request_id: Uuid,
275 /// Retry duration in seconds.
276 retry_after: Option<f64>,
277 },
278 UsageUpdated {
279 amount: usize,
280 limit: UsageLimit,
281 },
282 ToolUseLimitReached,
283}
284
285#[derive(Serialize, Deserialize)]
286#[serde(rename_all = "snake_case")]
287pub enum CompletionEvent<T> {
288 Status(CompletionRequestStatus),
289 Event(T),
290}
291
292impl<T> CompletionEvent<T> {
293 pub fn into_status(self) -> Option<CompletionRequestStatus> {
294 match self {
295 Self::Status(status) => Some(status),
296 Self::Event(_) => None,
297 }
298 }
299
300 pub fn into_event(self) -> Option<T> {
301 match self {
302 Self::Event(event) => Some(event),
303 Self::Status(_) => None,
304 }
305 }
306}
307
308#[derive(Serialize, Deserialize)]
309pub struct WebSearchBody {
310 pub query: String,
311}
312
313#[derive(Debug, Serialize, Deserialize, Clone)]
314pub struct WebSearchResponse {
315 pub results: Vec<WebSearchResult>,
316}
317
318#[derive(Debug, Serialize, Deserialize, Clone)]
319pub struct WebSearchResult {
320 pub title: String,
321 pub url: String,
322 pub text: String,
323}
324
325#[derive(Serialize, Deserialize)]
326pub struct CountTokensBody {
327 pub provider: LanguageModelProvider,
328 pub model: String,
329 pub provider_request: serde_json::Value,
330}
331
332#[derive(Serialize, Deserialize)]
333pub struct CountTokensResponse {
334 pub tokens: usize,
335}
336
337#[derive(Debug, PartialEq, Eq, Hash, Clone, Serialize, Deserialize)]
338pub struct LanguageModelId(pub Arc<str>);
339
340impl std::fmt::Display for LanguageModelId {
341 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
342 write!(f, "{}", self.0)
343 }
344}
345
346#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
347pub struct LanguageModel {
348 pub provider: LanguageModelProvider,
349 pub id: LanguageModelId,
350 pub display_name: String,
351 pub max_token_count: usize,
352 pub max_token_count_in_max_mode: Option<usize>,
353 pub max_output_tokens: usize,
354 pub supports_tools: bool,
355 pub supports_images: bool,
356 pub supports_thinking: bool,
357 pub supports_max_mode: bool,
358 // only used by OpenAI and xAI
359 #[serde(default)]
360 pub supports_parallel_tool_calls: bool,
361}
362
363#[derive(Debug, Serialize, Deserialize)]
364pub struct ListModelsResponse {
365 pub models: Vec<LanguageModel>,
366 pub default_model: Option<LanguageModelId>,
367 pub default_fast_model: Option<LanguageModelId>,
368 pub recommended_models: Vec<LanguageModelId>,
369}
370
371#[derive(Debug, Serialize, Deserialize)]
372pub struct GetSubscriptionResponse {
373 pub plan: PlanV1,
374 pub usage: Option<CurrentUsage>,
375}
376
377#[derive(Debug, PartialEq, Serialize, Deserialize)]
378pub struct CurrentUsage {
379 pub model_requests: UsageData,
380 pub edit_predictions: UsageData,
381}
382
383#[derive(Debug, PartialEq, Serialize, Deserialize)]
384pub struct UsageData {
385 pub used: u32,
386 pub limit: UsageLimit,
387}
388
389#[cfg(test)]
390mod tests {
391 use pretty_assertions::assert_eq;
392 use serde_json::json;
393
394 use super::*;
395
396 #[test]
397 fn test_plan_v1_deserialize_snake_case() {
398 let plan = serde_json::from_value::<PlanV1>(json!("zed_free")).unwrap();
399 assert_eq!(plan, PlanV1::ZedFree);
400
401 let plan = serde_json::from_value::<PlanV1>(json!("zed_pro")).unwrap();
402 assert_eq!(plan, PlanV1::ZedPro);
403
404 let plan = serde_json::from_value::<PlanV1>(json!("zed_pro_trial")).unwrap();
405 assert_eq!(plan, PlanV1::ZedProTrial);
406 }
407
408 #[test]
409 fn test_plan_v1_deserialize_aliases() {
410 let plan = serde_json::from_value::<PlanV1>(json!("Free")).unwrap();
411 assert_eq!(plan, PlanV1::ZedFree);
412
413 let plan = serde_json::from_value::<PlanV1>(json!("ZedPro")).unwrap();
414 assert_eq!(plan, PlanV1::ZedPro);
415
416 let plan = serde_json::from_value::<PlanV1>(json!("ZedProTrial")).unwrap();
417 assert_eq!(plan, PlanV1::ZedProTrial);
418 }
419
420 #[test]
421 fn test_plan_v2_deserialize_snake_case() {
422 let plan = serde_json::from_value::<PlanV2>(json!("zed_free")).unwrap();
423 assert_eq!(plan, PlanV2::ZedFree);
424
425 let plan = serde_json::from_value::<PlanV2>(json!("zed_pro")).unwrap();
426 assert_eq!(plan, PlanV2::ZedPro);
427
428 let plan = serde_json::from_value::<PlanV2>(json!("zed_pro_trial")).unwrap();
429 assert_eq!(plan, PlanV2::ZedProTrial);
430 }
431
432 #[test]
433 fn test_usage_limit_from_str() {
434 let limit = UsageLimit::from_str("unlimited").unwrap();
435 assert!(matches!(limit, UsageLimit::Unlimited));
436
437 let limit = UsageLimit::from_str(&0.to_string()).unwrap();
438 assert!(matches!(limit, UsageLimit::Limited(0)));
439
440 let limit = UsageLimit::from_str(&50.to_string()).unwrap();
441 assert!(matches!(limit, UsageLimit::Limited(50)));
442
443 for value in ["not_a_number", "50xyz"] {
444 let limit = UsageLimit::from_str(value);
445 assert!(limit.is_err());
446 }
447 }
448}