1mod model;
2mod rate_limiter;
3mod registry;
4mod request;
5mod role;
6mod telemetry;
7
8#[cfg(any(test, feature = "test-support"))]
9pub mod fake_provider;
10
11use anyhow::{Result, anyhow};
12use client::Client;
13use futures::FutureExt;
14use futures::{StreamExt, future::BoxFuture, stream::BoxStream};
15use gpui::{AnyElement, AnyView, App, AsyncApp, SharedString, Task, Window};
16use http_client::http::{HeaderMap, HeaderValue};
17use icons::IconName;
18use parking_lot::Mutex;
19use proto::Plan;
20use schemars::JsonSchema;
21use serde::{Deserialize, Serialize, de::DeserializeOwned};
22use std::fmt;
23use std::ops::{Add, Sub};
24use std::str::FromStr as _;
25use std::sync::Arc;
26use thiserror::Error;
27use util::serde::is_default;
28use zed_llm_client::{
29 MODEL_REQUESTS_USAGE_AMOUNT_HEADER_NAME, MODEL_REQUESTS_USAGE_LIMIT_HEADER_NAME, UsageLimit,
30};
31
32pub use crate::model::*;
33pub use crate::rate_limiter::*;
34pub use crate::registry::*;
35pub use crate::request::*;
36pub use crate::role::*;
37pub use crate::telemetry::*;
38
39pub const ZED_CLOUD_PROVIDER_ID: &str = "zed.dev";
40
41pub fn init(client: Arc<Client>, cx: &mut App) {
42 registry::init(cx);
43 RefreshLlmTokenListener::register(client.clone(), cx);
44}
45
46/// The availability of a [`LanguageModel`].
47#[derive(Debug, PartialEq, Eq, Clone, Copy)]
48pub enum LanguageModelAvailability {
49 /// The language model is available to the general public.
50 Public,
51 /// The language model is available to users on the indicated plan.
52 RequiresPlan(Plan),
53}
54
55/// Configuration for caching language model messages.
56#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, JsonSchema)]
57pub struct LanguageModelCacheConfiguration {
58 pub max_cache_anchors: usize,
59 pub should_speculate: bool,
60 pub min_total_token: usize,
61}
62
63/// A completion event from a language model.
64#[derive(Debug, PartialEq, Clone, Serialize, Deserialize)]
65pub enum LanguageModelCompletionEvent {
66 Stop(StopReason),
67 Text(String),
68 Thinking {
69 text: String,
70 signature: Option<String>,
71 },
72 ToolUse(LanguageModelToolUse),
73 StartMessage {
74 message_id: String,
75 },
76 UsageUpdate(TokenUsage),
77}
78
79/// Indicates the format used to define the input schema for a language model tool.
80#[derive(Debug, PartialEq, Eq, Clone, Copy, Hash)]
81pub enum LanguageModelToolSchemaFormat {
82 /// A JSON schema, see https://json-schema.org
83 JsonSchema,
84 /// A subset of an OpenAPI 3.0 schema object supported by Google AI, see https://ai.google.dev/api/caching#Schema
85 JsonSchemaSubset,
86}
87
88#[derive(Debug, PartialEq, Clone, Copy, Serialize, Deserialize)]
89#[serde(rename_all = "snake_case")]
90pub enum StopReason {
91 EndTurn,
92 MaxTokens,
93 ToolUse,
94}
95
96#[derive(Debug, Clone, Copy)]
97pub struct RequestUsage {
98 pub limit: UsageLimit,
99 pub amount: i32,
100}
101
102impl RequestUsage {
103 pub fn from_headers(headers: &HeaderMap<HeaderValue>) -> Result<Self> {
104 let limit = headers
105 .get(MODEL_REQUESTS_USAGE_LIMIT_HEADER_NAME)
106 .ok_or_else(|| anyhow!("missing {MODEL_REQUESTS_USAGE_LIMIT_HEADER_NAME:?} header"))?;
107 let limit = UsageLimit::from_str(limit.to_str()?)?;
108
109 let amount = headers
110 .get(MODEL_REQUESTS_USAGE_AMOUNT_HEADER_NAME)
111 .ok_or_else(|| anyhow!("missing {MODEL_REQUESTS_USAGE_AMOUNT_HEADER_NAME:?} header"))?;
112 let amount = amount.to_str()?.parse::<i32>()?;
113
114 Ok(Self { limit, amount })
115 }
116}
117
118#[derive(Debug, PartialEq, Clone, Copy, Serialize, Deserialize, Default)]
119pub struct TokenUsage {
120 #[serde(default, skip_serializing_if = "is_default")]
121 pub input_tokens: u32,
122 #[serde(default, skip_serializing_if = "is_default")]
123 pub output_tokens: u32,
124 #[serde(default, skip_serializing_if = "is_default")]
125 pub cache_creation_input_tokens: u32,
126 #[serde(default, skip_serializing_if = "is_default")]
127 pub cache_read_input_tokens: u32,
128}
129
130impl TokenUsage {
131 pub fn total_tokens(&self) -> u32 {
132 self.input_tokens
133 + self.output_tokens
134 + self.cache_read_input_tokens
135 + self.cache_creation_input_tokens
136 }
137}
138
139impl Add<TokenUsage> for TokenUsage {
140 type Output = Self;
141
142 fn add(self, other: Self) -> Self {
143 Self {
144 input_tokens: self.input_tokens + other.input_tokens,
145 output_tokens: self.output_tokens + other.output_tokens,
146 cache_creation_input_tokens: self.cache_creation_input_tokens
147 + other.cache_creation_input_tokens,
148 cache_read_input_tokens: self.cache_read_input_tokens + other.cache_read_input_tokens,
149 }
150 }
151}
152
153impl Sub<TokenUsage> for TokenUsage {
154 type Output = Self;
155
156 fn sub(self, other: Self) -> Self {
157 Self {
158 input_tokens: self.input_tokens - other.input_tokens,
159 output_tokens: self.output_tokens - other.output_tokens,
160 cache_creation_input_tokens: self.cache_creation_input_tokens
161 - other.cache_creation_input_tokens,
162 cache_read_input_tokens: self.cache_read_input_tokens - other.cache_read_input_tokens,
163 }
164 }
165}
166
167#[derive(Debug, PartialEq, Eq, Hash, Clone, Serialize, Deserialize)]
168pub struct LanguageModelToolUseId(Arc<str>);
169
170impl fmt::Display for LanguageModelToolUseId {
171 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
172 write!(f, "{}", self.0)
173 }
174}
175
176impl<T> From<T> for LanguageModelToolUseId
177where
178 T: Into<Arc<str>>,
179{
180 fn from(value: T) -> Self {
181 Self(value.into())
182 }
183}
184
185#[derive(Debug, PartialEq, Eq, Hash, Clone, Serialize, Deserialize)]
186pub struct LanguageModelToolUse {
187 pub id: LanguageModelToolUseId,
188 pub name: Arc<str>,
189 pub input: serde_json::Value,
190}
191
192pub struct LanguageModelTextStream {
193 pub message_id: Option<String>,
194 pub stream: BoxStream<'static, Result<String>>,
195 // Has complete token usage after the stream has finished
196 pub last_token_usage: Arc<Mutex<TokenUsage>>,
197}
198
199impl Default for LanguageModelTextStream {
200 fn default() -> Self {
201 Self {
202 message_id: None,
203 stream: Box::pin(futures::stream::empty()),
204 last_token_usage: Arc::new(Mutex::new(TokenUsage::default())),
205 }
206 }
207}
208
209pub trait LanguageModel: Send + Sync {
210 fn id(&self) -> LanguageModelId;
211 fn name(&self) -> LanguageModelName;
212 fn provider_id(&self) -> LanguageModelProviderId;
213 fn provider_name(&self) -> LanguageModelProviderName;
214 fn telemetry_id(&self) -> String;
215
216 fn api_key(&self, _cx: &App) -> Option<String> {
217 None
218 }
219
220 /// Returns the availability of this language model.
221 fn availability(&self) -> LanguageModelAvailability {
222 LanguageModelAvailability::Public
223 }
224
225 /// Whether this model supports tools.
226 fn supports_tools(&self) -> bool;
227
228 fn tool_input_format(&self) -> LanguageModelToolSchemaFormat {
229 LanguageModelToolSchemaFormat::JsonSchema
230 }
231
232 fn max_token_count(&self) -> usize;
233 fn max_output_tokens(&self) -> Option<u32> {
234 None
235 }
236
237 fn count_tokens(
238 &self,
239 request: LanguageModelRequest,
240 cx: &App,
241 ) -> BoxFuture<'static, Result<usize>>;
242
243 fn stream_completion(
244 &self,
245 request: LanguageModelRequest,
246 cx: &AsyncApp,
247 ) -> BoxFuture<'static, Result<BoxStream<'static, Result<LanguageModelCompletionEvent>>>>;
248
249 fn stream_completion_with_usage(
250 &self,
251 request: LanguageModelRequest,
252 cx: &AsyncApp,
253 ) -> BoxFuture<
254 'static,
255 Result<(
256 BoxStream<'static, Result<LanguageModelCompletionEvent>>,
257 Option<RequestUsage>,
258 )>,
259 > {
260 self.stream_completion(request, cx)
261 .map(|result| result.map(|stream| (stream, None)))
262 .boxed()
263 }
264
265 fn stream_completion_text(
266 &self,
267 request: LanguageModelRequest,
268 cx: &AsyncApp,
269 ) -> BoxFuture<'static, Result<LanguageModelTextStream>> {
270 self.stream_completion_text_with_usage(request, cx)
271 .map(|result| result.map(|(stream, _usage)| stream))
272 .boxed()
273 }
274
275 fn stream_completion_text_with_usage(
276 &self,
277 request: LanguageModelRequest,
278 cx: &AsyncApp,
279 ) -> BoxFuture<'static, Result<(LanguageModelTextStream, Option<RequestUsage>)>> {
280 let future = self.stream_completion_with_usage(request, cx);
281
282 async move {
283 let (events, usage) = future.await?;
284 let mut events = events.fuse();
285 let mut message_id = None;
286 let mut first_item_text = None;
287 let last_token_usage = Arc::new(Mutex::new(TokenUsage::default()));
288
289 if let Some(first_event) = events.next().await {
290 match first_event {
291 Ok(LanguageModelCompletionEvent::StartMessage { message_id: id }) => {
292 message_id = Some(id.clone());
293 }
294 Ok(LanguageModelCompletionEvent::Text(text)) => {
295 first_item_text = Some(text);
296 }
297 _ => (),
298 }
299 }
300
301 let stream = futures::stream::iter(first_item_text.map(Ok))
302 .chain(events.filter_map({
303 let last_token_usage = last_token_usage.clone();
304 move |result| {
305 let last_token_usage = last_token_usage.clone();
306 async move {
307 match result {
308 Ok(LanguageModelCompletionEvent::StartMessage { .. }) => None,
309 Ok(LanguageModelCompletionEvent::Text(text)) => Some(Ok(text)),
310 Ok(LanguageModelCompletionEvent::Thinking { .. }) => None,
311 Ok(LanguageModelCompletionEvent::Stop(_)) => None,
312 Ok(LanguageModelCompletionEvent::ToolUse(_)) => None,
313 Ok(LanguageModelCompletionEvent::UsageUpdate(token_usage)) => {
314 *last_token_usage.lock() = token_usage;
315 None
316 }
317 Err(err) => Some(Err(err)),
318 }
319 }
320 }
321 }))
322 .boxed();
323
324 Ok((
325 LanguageModelTextStream {
326 message_id,
327 stream,
328 last_token_usage,
329 },
330 usage,
331 ))
332 }
333 .boxed()
334 }
335
336 fn cache_configuration(&self) -> Option<LanguageModelCacheConfiguration> {
337 None
338 }
339
340 #[cfg(any(test, feature = "test-support"))]
341 fn as_fake(&self) -> &fake_provider::FakeLanguageModel {
342 unimplemented!()
343 }
344}
345
346#[derive(Debug, Error)]
347pub enum LanguageModelKnownError {
348 #[error("Context window limit exceeded ({tokens})")]
349 ContextWindowLimitExceeded { tokens: usize },
350}
351
352pub trait LanguageModelTool: 'static + DeserializeOwned + JsonSchema {
353 fn name() -> String;
354 fn description() -> String;
355}
356
357/// An error that occurred when trying to authenticate the language model provider.
358#[derive(Debug, Error)]
359pub enum AuthenticateError {
360 #[error("credentials not found")]
361 CredentialsNotFound,
362 #[error(transparent)]
363 Other(#[from] anyhow::Error),
364}
365
366pub trait LanguageModelProvider: 'static {
367 fn id(&self) -> LanguageModelProviderId;
368 fn name(&self) -> LanguageModelProviderName;
369 fn icon(&self) -> IconName {
370 IconName::ZedAssistant
371 }
372 fn default_model(&self, cx: &App) -> Option<Arc<dyn LanguageModel>>;
373 fn provided_models(&self, cx: &App) -> Vec<Arc<dyn LanguageModel>>;
374 fn recommended_models(&self, _cx: &App) -> Vec<Arc<dyn LanguageModel>> {
375 Vec::new()
376 }
377 fn load_model(&self, _model: Arc<dyn LanguageModel>, _cx: &App) {}
378 fn is_authenticated(&self, cx: &App) -> bool;
379 fn authenticate(&self, cx: &mut App) -> Task<Result<(), AuthenticateError>>;
380 fn configuration_view(&self, window: &mut Window, cx: &mut App) -> AnyView;
381 fn must_accept_terms(&self, _cx: &App) -> bool {
382 false
383 }
384 fn render_accept_terms(
385 &self,
386 _view: LanguageModelProviderTosView,
387 _cx: &mut App,
388 ) -> Option<AnyElement> {
389 None
390 }
391 fn reset_credentials(&self, cx: &mut App) -> Task<Result<()>>;
392}
393
394#[derive(PartialEq, Eq)]
395pub enum LanguageModelProviderTosView {
396 /// When there are some past interactions in the Agent Panel.
397 ThreadtEmptyState,
398 /// When there are no past interactions in the Agent Panel.
399 ThreadFreshStart,
400 PromptEditorPopup,
401 Configuration,
402}
403
404pub trait LanguageModelProviderState: 'static {
405 type ObservableEntity;
406
407 fn observable_entity(&self) -> Option<gpui::Entity<Self::ObservableEntity>>;
408
409 fn subscribe<T: 'static>(
410 &self,
411 cx: &mut gpui::Context<T>,
412 callback: impl Fn(&mut T, &mut gpui::Context<T>) + 'static,
413 ) -> Option<gpui::Subscription> {
414 let entity = self.observable_entity()?;
415 Some(cx.observe(&entity, move |this, _, cx| {
416 callback(this, cx);
417 }))
418 }
419}
420
421#[derive(Clone, Eq, PartialEq, Hash, Debug, Ord, PartialOrd, Serialize, Deserialize)]
422pub struct LanguageModelId(pub SharedString);
423
424#[derive(Clone, Eq, PartialEq, Hash, Debug, Ord, PartialOrd)]
425pub struct LanguageModelName(pub SharedString);
426
427#[derive(Clone, Eq, PartialEq, Hash, Debug, Ord, PartialOrd)]
428pub struct LanguageModelProviderId(pub SharedString);
429
430#[derive(Clone, Eq, PartialEq, Hash, Debug, Ord, PartialOrd)]
431pub struct LanguageModelProviderName(pub SharedString);
432
433impl fmt::Display for LanguageModelProviderId {
434 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
435 write!(f, "{}", self.0)
436 }
437}
438
439impl From<String> for LanguageModelId {
440 fn from(value: String) -> Self {
441 Self(SharedString::from(value))
442 }
443}
444
445impl From<String> for LanguageModelName {
446 fn from(value: String) -> Self {
447 Self(SharedString::from(value))
448 }
449}
450
451impl From<String> for LanguageModelProviderId {
452 fn from(value: String) -> Self {
453 Self(SharedString::from(value))
454 }
455}
456
457impl From<String> for LanguageModelProviderName {
458 fn from(value: String) -> Self {
459 Self(SharedString::from(value))
460 }
461}