pub mod predict_edits_v3; use std::str::FromStr;use std::sync::Arc; use anyhow::Context as _;use serde::{Deserialize, Serialize};use strum::{Display, EnumIter, EnumString};use uuid::Uuid; /// The name of the header used to indicate which version of Zed the client is running.pub const ZED_VERSION_HEADER_NAME: &str = "x-zed-version"; /// The name of the header used to indicate when a request failed due to an/// expired LLM token.////// The client may use this as a signal to refresh the token.pub const EXPIRED_LLM_TOKEN_HEADER_NAME: &str = "x-zed-expired-token"; /// The name of the header used to indicate when a request failed due to an outdated LLM token.////// A token is considered "outdated" when we can't parse the claims (e.g., after adding a new required claim).////// This is distinct from [`EXPIRED_LLM_TOKEN_HEADER_NAME`] which indicates the token's time-based validity has passed./// An outdated token means the token's structure is incompatible with the current server expectations.pub const OUTDATED_LLM_TOKEN_HEADER_NAME: &str = "x-zed-outdated-token"; /// The name of the header used to indicate the usage limit for edit predictions.pub const EDIT_PREDICTIONS_USAGE_LIMIT_HEADER_NAME: &str = "x-zed-edit-predictions-usage-limit"; /// The name of the header used to indicate the usage amount for edit predictions.pub const EDIT_PREDICTIONS_USAGE_AMOUNT_HEADER_NAME: &str = "x-zed-edit-predictions-usage-amount"; pub const EDIT_PREDICTIONS_RESOURCE_HEADER_VALUE: &str = "edit_predictions"; /// The name of the header used to indicate the minimum required Zed version.////// This can be used to force a Zed upgrade in order to continue communicating/// with the LLM service.pub const MINIMUM_REQUIRED_VERSION_HEADER_NAME: &str = "x-zed-minimum-required-version"; /// The name of the header used by the client to indicate to the server that it supports receiving status messages.pub const CLIENT_SUPPORTS_STATUS_MESSAGES_HEADER_NAME: &str = "x-zed-client-supports-status-messages"; /// The name of the header used by the client to indicate to the server that it supports receiving a "stream_ended" request completion status.pub const CLIENT_SUPPORTS_STATUS_STREAM_ENDED_HEADER_NAME: &str = "x-zed-client-supports-stream-ended-request-completion-status"; /// The name of the header used by the server to indicate to the client that it supports sending status messages.pub const SERVER_SUPPORTS_STATUS_MESSAGES_HEADER_NAME: &str = "x-zed-server-supports-status-messages"; /// The name of the header used by the client to indicate that it supports receiving xAI models.pub const CLIENT_SUPPORTS_X_AI_HEADER_NAME: &str = "x-zed-client-supports-x-ai"; /// The maximum number of edit predictions that can be rejected per request.pub const MAX_EDIT_PREDICTION_REJECTIONS_PER_REQUEST: usize = 100; #[derive(Debug, PartialEq, Clone, Copy, Serialize, Deserialize)]#[serde(rename_all = "snake_case")]pub enum UsageLimit { Limited(i32), Unlimited,} impl FromStr for UsageLimit { type Err = anyhow::Error; fn from_str(value: &str) -> Result<Self, Self::Err> { match value { "unlimited" => Ok(Self::Unlimited), limit => limit .parse::<i32>() .map(Self::Limited) .context("failed to parse limit"), } }} #[derive( Debug, PartialEq, Eq, Hash, Clone, Copy, Serialize, Deserialize, EnumString, EnumIter, Display,)]#[serde(rename_all = "snake_case")]#[strum(serialize_all = "snake_case")]pub enum LanguageModelProvider { Anthropic, OpenAi, Google, XAi,} #[derive(Debug, Clone, Serialize, Deserialize)]pub struct PredictEditsBody { #[serde(skip_serializing_if = "Option::is_none", default)] pub outline: Option<String>, pub input_events: String, pub input_excerpt: String, #[serde(skip_serializing_if = "Option::is_none", default)] pub speculated_output: Option<String>, /// Whether the user provided consent for sampling this interaction. #[serde(default, alias = "data_collection_permission")] pub can_collect_data: bool, #[serde(skip_serializing_if = "Option::is_none", default)] pub diagnostic_groups: Option<Vec<(String, serde_json::Value)>>, /// Info about the git repository state, only present when can_collect_data is true. #[serde(skip_serializing_if = "Option::is_none", default)] pub git_info: Option<PredictEditsGitInfo>, /// The trigger for this request. #[serde(default)] pub trigger: PredictEditsRequestTrigger,} #[derive(Default, Debug, Clone, Copy, Serialize, Deserialize)]pub enum PredictEditsRequestTrigger { Testing, Diagnostics, Cli, #[default] Other,} #[derive(Debug, Clone, Serialize, Deserialize)]pub struct PredictEditsGitInfo { /// SHA of git HEAD commit at time of prediction. #[serde(skip_serializing_if = "Option::is_none", default)] pub head_sha: Option<String>, /// URL of the remote called `origin`. #[serde(skip_serializing_if = "Option::is_none", default)] pub remote_origin_url: Option<String>, /// URL of the remote called `upstream`. #[serde(skip_serializing_if = "Option::is_none", default)] pub remote_upstream_url: Option<String>,} #[derive(Debug, Clone, Serialize, Deserialize)]pub struct PredictEditsResponse { pub request_id: String, pub output_excerpt: String,} #[derive(Debug, Clone, Serialize, Deserialize)]pub struct AcceptEditPredictionBody { pub request_id: String, #[serde(default, skip_serializing_if = "Option::is_none")] pub model_version: Option<String>, #[serde(default, skip_serializing_if = "Option::is_none")] pub e2e_latency_ms: Option<u128>,} #[derive(Debug, Clone, Deserialize)]pub struct RejectEditPredictionsBody { pub rejections: Vec<EditPredictionRejection>,} #[derive(Debug, Clone, Serialize)]pub struct RejectEditPredictionsBodyRef<'a> { pub rejections: &'a [EditPredictionRejection],} #[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]pub struct EditPredictionRejection { pub request_id: String, #[serde(default)] pub reason: EditPredictionRejectReason, pub was_shown: bool, #[serde(default, skip_serializing_if = "Option::is_none")] pub model_version: Option<String>, #[serde(default, skip_serializing_if = "Option::is_none")] pub e2e_latency_ms: Option<u128>,} #[derive(Default, Debug, Clone, Copy, Serialize, Deserialize, PartialEq)]pub enum EditPredictionRejectReason { /// New requests were triggered before this one completed Canceled, /// No edits returned Empty, /// Edits returned, but none remained after interpolation InterpolatedEmpty, /// The new prediction was preferred over the current one Replaced, /// The current prediction was preferred over the new one CurrentPreferred, /// The current prediction was discarded #[default] Discarded, /// The current prediction was explicitly rejected by the user Rejected,} #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy, Serialize, Deserialize)]#[serde(rename_all = "snake_case")]pub enum CompletionIntent { UserPrompt, ToolResults, ThreadSummarization, ThreadContextSummarization, CreateFile, EditFile, InlineAssist, TerminalInlineAssist, GenerateGitCommitMessage,} #[derive(Debug, Serialize, Deserialize)]pub struct CompletionBody { #[serde(skip_serializing_if = "Option::is_none", default)] pub thread_id: Option<String>, #[serde(skip_serializing_if = "Option::is_none", default)] pub prompt_id: Option<String>, #[serde(skip_serializing_if = "Option::is_none", default)] pub intent: Option<CompletionIntent>, pub provider: LanguageModelProvider, pub model: String, pub provider_request: serde_json::Value,} #[derive(Debug, PartialEq, Clone, Serialize, Deserialize)]#[serde(rename_all = "snake_case")]pub enum CompletionRequestStatus { Queued { position: usize, }, Started, Failed { code: String, message: String, request_id: Uuid, /// Retry duration in seconds. retry_after: Option<f64>, }, /// The cloud sends a StreamEnded message when the stream from the LLM provider finishes. StreamEnded, #[serde(other)] Unknown,} #[derive(Serialize, Deserialize)]#[serde(rename_all = "snake_case")]pub enum CompletionEvent<T> { Status(CompletionRequestStatus), Event(T),} impl<T> CompletionEvent<T> { pub fn into_status(self) -> Option<CompletionRequestStatus> { match self { Self::Status(status) => Some(status), Self::Event(_) => None, } } pub fn into_event(self) -> Option<T> { match self { Self::Event(event) => Some(event), Self::Status(_) => None, } }} #[derive(Serialize, Deserialize)]pub struct WebSearchBody { pub query: String,} #[derive(Debug, Serialize, Deserialize, Clone)]pub struct WebSearchResponse { pub results: Vec<WebSearchResult>,} #[derive(Debug, Serialize, Deserialize, Clone)]pub struct WebSearchResult { pub title: String, pub url: String, pub text: String,} #[derive(Serialize, Deserialize)]pub struct CountTokensBody { pub provider: LanguageModelProvider, pub model: String, pub provider_request: serde_json::Value,} #[derive(Serialize, Deserialize)]pub struct CountTokensResponse { pub tokens: usize,} #[derive(Debug, PartialEq, Eq, Hash, Clone, Serialize, Deserialize)]pub struct LanguageModelId(pub Arc<str>); impl std::fmt::Display for LanguageModelId { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { write!(f, "{}", self.0) }} #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]pub struct LanguageModel { pub provider: LanguageModelProvider, pub id: LanguageModelId, pub display_name: String, #[serde(default)] pub is_latest: bool, pub max_token_count: usize, pub max_token_count_in_max_mode: Option<usize>, pub max_output_tokens: usize, pub supports_tools: bool, pub supports_images: bool, pub supports_thinking: bool, #[serde(default)] pub supports_fast_mode: bool, pub supported_effort_levels: Vec<SupportedEffortLevel>, #[serde(default)] pub supports_streaming_tools: bool, /// Only used by OpenAI and xAI. #[serde(default)] pub supports_parallel_tool_calls: bool,} #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]pub struct SupportedEffortLevel { pub name: Arc<str>, pub value: Arc<str>, #[serde(default, skip_serializing_if = "Option::is_none")] pub is_default: Option<bool>,} #[derive(Debug, Serialize, Deserialize)]pub struct ListModelsResponse { pub models: Vec<LanguageModel>, pub default_model: Option<LanguageModelId>, pub default_fast_model: Option<LanguageModelId>, pub recommended_models: Vec<LanguageModelId>,} #[derive(Debug, PartialEq, Serialize, Deserialize)]pub struct CurrentUsage { pub edit_predictions: UsageData,} #[derive(Debug, PartialEq, Serialize, Deserialize)]pub struct UsageData { pub used: u32, pub limit: UsageLimit,} #[cfg(test)]mod tests { use super::*; #[test] fn test_usage_limit_from_str() { let limit = UsageLimit::from_str("unlimited").unwrap(); assert!(matches!(limit, UsageLimit::Unlimited)); let limit = UsageLimit::from_str(&0.to_string()).unwrap(); assert!(matches!(limit, UsageLimit::Limited(0))); let limit = UsageLimit::from_str(&50.to_string()).unwrap(); assert!(matches!(limit, UsageLimit::Limited(50))); for value in ["not_a_number", "50xyz"] { let limit = UsageLimit::from_str(value); assert!(limit.is_err()); } }}
pub mod predict_edits_v3;
use std::str::FromStr;
use std::sync::Arc;
use anyhow::Context as _;
use serde::{Deserialize, Serialize};
use strum::{Display, EnumIter, EnumString};
use uuid::Uuid;
/// The name of the header used to indicate which version of Zed the client is running.
pub const ZED_VERSION_HEADER_NAME: &str = "x-zed-version";
/// The name of the header used to indicate when a request failed due to an
/// expired LLM token.
///
/// The client may use this as a signal to refresh the token.
pub const EXPIRED_LLM_TOKEN_HEADER_NAME: &str = "x-zed-expired-token";
/// The name of the header used to indicate when a request failed due to an outdated LLM token.
///
/// A token is considered "outdated" when we can't parse the claims (e.g., after adding a new required claim).
///
/// This is distinct from [`EXPIRED_LLM_TOKEN_HEADER_NAME`] which indicates the token's time-based validity has passed.
/// An outdated token means the token's structure is incompatible with the current server expectations.
pub const OUTDATED_LLM_TOKEN_HEADER_NAME: &str = "x-zed-outdated-token";
/// The name of the header used to indicate the usage limit for edit predictions.
pub const EDIT_PREDICTIONS_USAGE_LIMIT_HEADER_NAME: &str = "x-zed-edit-predictions-usage-limit";
/// The name of the header used to indicate the usage amount for edit predictions.
pub const EDIT_PREDICTIONS_USAGE_AMOUNT_HEADER_NAME: &str = "x-zed-edit-predictions-usage-amount";
pub const EDIT_PREDICTIONS_RESOURCE_HEADER_VALUE: &str = "edit_predictions";
/// The name of the header used to indicate the minimum required Zed version.
///
/// This can be used to force a Zed upgrade in order to continue communicating
/// with the LLM service.
pub const MINIMUM_REQUIRED_VERSION_HEADER_NAME: &str = "x-zed-minimum-required-version";
/// The name of the header used by the client to indicate to the server that it supports receiving status messages.
pub const CLIENT_SUPPORTS_STATUS_MESSAGES_HEADER_NAME: &str =
"x-zed-client-supports-status-messages";
/// The name of the header used by the client to indicate to the server that it supports receiving a "stream_ended" request completion status.
pub const CLIENT_SUPPORTS_STATUS_STREAM_ENDED_HEADER_NAME: &str =
"x-zed-client-supports-stream-ended-request-completion-status";
/// The name of the header used by the server to indicate to the client that it supports sending status messages.
pub const SERVER_SUPPORTS_STATUS_MESSAGES_HEADER_NAME: &str =
"x-zed-server-supports-status-messages";
/// The name of the header used by the client to indicate that it supports receiving xAI models.
pub const CLIENT_SUPPORTS_X_AI_HEADER_NAME: &str = "x-zed-client-supports-x-ai";
/// The maximum number of edit predictions that can be rejected per request.
pub const MAX_EDIT_PREDICTION_REJECTIONS_PER_REQUEST: usize = 100;
#[derive(Debug, PartialEq, Clone, Copy, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum UsageLimit {
Limited(i32),
Unlimited,
}
impl FromStr for UsageLimit {
type Err = anyhow::Error;
fn from_str(value: &str) -> Result<Self, Self::Err> {
match value {
"unlimited" => Ok(Self::Unlimited),
limit => limit
.parse::<i32>()
.map(Self::Limited)
.context("failed to parse limit"),
}
}
}
#[derive(
Debug, PartialEq, Eq, Hash, Clone, Copy, Serialize, Deserialize, EnumString, EnumIter, Display,
)]
#[serde(rename_all = "snake_case")]
#[strum(serialize_all = "snake_case")]
pub enum LanguageModelProvider {
Anthropic,
OpenAi,
Google,
XAi,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PredictEditsBody {
#[serde(skip_serializing_if = "Option::is_none", default)]
pub outline: Option<String>,
pub input_events: String,
pub input_excerpt: String,
#[serde(skip_serializing_if = "Option::is_none", default)]
pub speculated_output: Option<String>,
/// Whether the user provided consent for sampling this interaction.
#[serde(default, alias = "data_collection_permission")]
pub can_collect_data: bool,
#[serde(skip_serializing_if = "Option::is_none", default)]
pub diagnostic_groups: Option<Vec<(String, serde_json::Value)>>,
/// Info about the git repository state, only present when can_collect_data is true.
#[serde(skip_serializing_if = "Option::is_none", default)]
pub git_info: Option<PredictEditsGitInfo>,
/// The trigger for this request.
#[serde(default)]
pub trigger: PredictEditsRequestTrigger,
}
#[derive(Default, Debug, Clone, Copy, Serialize, Deserialize)]
pub enum PredictEditsRequestTrigger {
Testing,
Diagnostics,
Cli,
#[default]
Other,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PredictEditsGitInfo {
/// SHA of git HEAD commit at time of prediction.
#[serde(skip_serializing_if = "Option::is_none", default)]
pub head_sha: Option<String>,
/// URL of the remote called `origin`.
#[serde(skip_serializing_if = "Option::is_none", default)]
pub remote_origin_url: Option<String>,
/// URL of the remote called `upstream`.
#[serde(skip_serializing_if = "Option::is_none", default)]
pub remote_upstream_url: Option<String>,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PredictEditsResponse {
pub request_id: String,
pub output_excerpt: String,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AcceptEditPredictionBody {
pub request_id: String,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub model_version: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub e2e_latency_ms: Option<u128>,
}
#[derive(Debug, Clone, Deserialize)]
pub struct RejectEditPredictionsBody {
pub rejections: Vec<EditPredictionRejection>,
}
#[derive(Debug, Clone, Serialize)]
pub struct RejectEditPredictionsBodyRef<'a> {
pub rejections: &'a [EditPredictionRejection],
}
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct EditPredictionRejection {
pub request_id: String,
#[serde(default)]
pub reason: EditPredictionRejectReason,
pub was_shown: bool,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub model_version: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub e2e_latency_ms: Option<u128>,
}
#[derive(Default, Debug, Clone, Copy, Serialize, Deserialize, PartialEq)]
pub enum EditPredictionRejectReason {
/// New requests were triggered before this one completed
Canceled,
/// No edits returned
Empty,
/// Edits returned, but none remained after interpolation
InterpolatedEmpty,
/// The new prediction was preferred over the current one
Replaced,
/// The current prediction was preferred over the new one
CurrentPreferred,
/// The current prediction was discarded
#[default]
Discarded,
/// The current prediction was explicitly rejected by the user
Rejected,
}
#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum CompletionIntent {
UserPrompt,
ToolResults,
ThreadSummarization,
ThreadContextSummarization,
CreateFile,
EditFile,
InlineAssist,
TerminalInlineAssist,
GenerateGitCommitMessage,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct CompletionBody {
#[serde(skip_serializing_if = "Option::is_none", default)]
pub thread_id: Option<String>,
#[serde(skip_serializing_if = "Option::is_none", default)]
pub prompt_id: Option<String>,
#[serde(skip_serializing_if = "Option::is_none", default)]
pub intent: Option<CompletionIntent>,
pub provider: LanguageModelProvider,
pub model: String,
pub provider_request: serde_json::Value,
}
#[derive(Debug, PartialEq, Clone, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum CompletionRequestStatus {
Queued {
position: usize,
},
Started,
Failed {
code: String,
message: String,
request_id: Uuid,
/// Retry duration in seconds.
retry_after: Option<f64>,
},
/// The cloud sends a StreamEnded message when the stream from the LLM provider finishes.
StreamEnded,
#[serde(other)]
Unknown,
}
#[derive(Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum CompletionEvent<T> {
Status(CompletionRequestStatus),
Event(T),
}
impl<T> CompletionEvent<T> {
pub fn into_status(self) -> Option<CompletionRequestStatus> {
match self {
Self::Status(status) => Some(status),
Self::Event(_) => None,
}
}
pub fn into_event(self) -> Option<T> {
match self {
Self::Event(event) => Some(event),
Self::Status(_) => None,
}
}
}
#[derive(Serialize, Deserialize)]
pub struct WebSearchBody {
pub query: String,
}
#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct WebSearchResponse {
pub results: Vec<WebSearchResult>,
}
#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct WebSearchResult {
pub title: String,
pub url: String,
pub text: String,
}
#[derive(Serialize, Deserialize)]
pub struct CountTokensBody {
pub provider: LanguageModelProvider,
pub model: String,
pub provider_request: serde_json::Value,
}
#[derive(Serialize, Deserialize)]
pub struct CountTokensResponse {
pub tokens: usize,
}
#[derive(Debug, PartialEq, Eq, Hash, Clone, Serialize, Deserialize)]
pub struct LanguageModelId(pub Arc<str>);
impl std::fmt::Display for LanguageModelId {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", self.0)
}
}
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct LanguageModel {
pub provider: LanguageModelProvider,
pub id: LanguageModelId,
pub display_name: String,
#[serde(default)]
pub is_latest: bool,
pub max_token_count: usize,
pub max_token_count_in_max_mode: Option<usize>,
pub max_output_tokens: usize,
pub supports_tools: bool,
pub supports_images: bool,
pub supports_thinking: bool,
#[serde(default)]
pub supports_fast_mode: bool,
pub supported_effort_levels: Vec<SupportedEffortLevel>,
#[serde(default)]
pub supports_streaming_tools: bool,
/// Only used by OpenAI and xAI.
#[serde(default)]
pub supports_parallel_tool_calls: bool,
}
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct SupportedEffortLevel {
pub name: Arc<str>,
pub value: Arc<str>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub is_default: Option<bool>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ListModelsResponse {
pub models: Vec<LanguageModel>,
pub default_model: Option<LanguageModelId>,
pub default_fast_model: Option<LanguageModelId>,
pub recommended_models: Vec<LanguageModelId>,
}
#[derive(Debug, PartialEq, Serialize, Deserialize)]
pub struct CurrentUsage {
pub edit_predictions: UsageData,
}
#[derive(Debug, PartialEq, Serialize, Deserialize)]
pub struct UsageData {
pub used: u32,
pub limit: UsageLimit,
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_usage_limit_from_str() {
let limit = UsageLimit::from_str("unlimited").unwrap();
assert!(matches!(limit, UsageLimit::Unlimited));
let limit = UsageLimit::from_str(&0.to_string()).unwrap();
assert!(matches!(limit, UsageLimit::Limited(0)));
let limit = UsageLimit::from_str(&50.to_string()).unwrap();
assert!(matches!(limit, UsageLimit::Limited(50)));
for value in ["not_a_number", "50xyz"] {
let limit = UsageLimit::from_str(value);
assert!(limit.is_err());
}
}
}