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