1use std::sync::Arc;
2
3use anyhow::Result;
4use assistant_tool::ToolWorkingSet;
5use chrono::{DateTime, Utc};
6use collections::{BTreeMap, HashMap, HashSet};
7use futures::future::Shared;
8use futures::{FutureExt as _, StreamExt as _};
9use gpui::{App, Context, EventEmitter, SharedString, Task};
10use language_model::{
11 LanguageModel, LanguageModelCompletionEvent, LanguageModelRegistry, LanguageModelRequest,
12 LanguageModelRequestMessage, LanguageModelToolResult, LanguageModelToolUse,
13 LanguageModelToolUseId, MaxMonthlySpendReachedError, MessageContent, PaymentRequiredError,
14 Role, StopReason,
15};
16use serde::{Deserialize, Serialize};
17use util::{post_inc, TryFutureExt as _};
18use uuid::Uuid;
19
20use crate::context::{attach_context_to_message, ContextId, ContextSnapshot};
21use crate::thread_store::SavedThread;
22
23#[derive(Debug, Clone, Copy)]
24pub enum RequestKind {
25 Chat,
26 /// Used when summarizing a thread.
27 Summarize,
28}
29
30#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Serialize, Deserialize)]
31pub struct ThreadId(Arc<str>);
32
33impl ThreadId {
34 pub fn new() -> Self {
35 Self(Uuid::new_v4().to_string().into())
36 }
37}
38
39impl std::fmt::Display for ThreadId {
40 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
41 write!(f, "{}", self.0)
42 }
43}
44
45#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy, Serialize, Deserialize)]
46pub struct MessageId(usize);
47
48impl MessageId {
49 fn post_inc(&mut self) -> Self {
50 Self(post_inc(&mut self.0))
51 }
52}
53
54/// A message in a [`Thread`].
55#[derive(Debug, Clone)]
56pub struct Message {
57 pub id: MessageId,
58 pub role: Role,
59 pub text: String,
60}
61
62#[derive(Debug)]
63pub struct ToolUse {
64 pub id: LanguageModelToolUseId,
65 pub name: SharedString,
66 pub status: ToolUseStatus,
67 pub input: serde_json::Value,
68}
69
70#[derive(Debug, Clone)]
71pub enum ToolUseStatus {
72 Pending,
73 Running,
74 Finished(SharedString),
75 Error(SharedString),
76}
77
78/// A thread of conversation with the LLM.
79pub struct Thread {
80 id: ThreadId,
81 updated_at: DateTime<Utc>,
82 summary: Option<SharedString>,
83 pending_summary: Task<Option<()>>,
84 messages: Vec<Message>,
85 next_message_id: MessageId,
86 context: BTreeMap<ContextId, ContextSnapshot>,
87 context_by_message: HashMap<MessageId, Vec<ContextId>>,
88 completion_count: usize,
89 pending_completions: Vec<PendingCompletion>,
90 tools: Arc<ToolWorkingSet>,
91 tool_uses_by_message: HashMap<MessageId, Vec<LanguageModelToolUse>>,
92 tool_results_by_message: HashMap<MessageId, Vec<LanguageModelToolResult>>,
93 pending_tool_uses_by_id: HashMap<LanguageModelToolUseId, PendingToolUse>,
94}
95
96impl Thread {
97 pub fn new(tools: Arc<ToolWorkingSet>, _cx: &mut Context<Self>) -> Self {
98 Self {
99 id: ThreadId::new(),
100 updated_at: Utc::now(),
101 summary: None,
102 pending_summary: Task::ready(None),
103 messages: Vec::new(),
104 next_message_id: MessageId(0),
105 context: BTreeMap::default(),
106 context_by_message: HashMap::default(),
107 completion_count: 0,
108 pending_completions: Vec::new(),
109 tools,
110 tool_uses_by_message: HashMap::default(),
111 tool_results_by_message: HashMap::default(),
112 pending_tool_uses_by_id: HashMap::default(),
113 }
114 }
115
116 pub fn from_saved(
117 id: ThreadId,
118 saved: SavedThread,
119 tools: Arc<ToolWorkingSet>,
120 _cx: &mut Context<Self>,
121 ) -> Self {
122 let next_message_id = MessageId(saved.messages.len());
123
124 Self {
125 id,
126 updated_at: saved.updated_at,
127 summary: Some(saved.summary),
128 pending_summary: Task::ready(None),
129 messages: saved
130 .messages
131 .into_iter()
132 .map(|message| Message {
133 id: message.id,
134 role: message.role,
135 text: message.text,
136 })
137 .collect(),
138 next_message_id,
139 context: BTreeMap::default(),
140 context_by_message: HashMap::default(),
141 completion_count: 0,
142 pending_completions: Vec::new(),
143 tools,
144 tool_uses_by_message: HashMap::default(),
145 tool_results_by_message: HashMap::default(),
146 pending_tool_uses_by_id: HashMap::default(),
147 }
148 }
149
150 pub fn id(&self) -> &ThreadId {
151 &self.id
152 }
153
154 pub fn is_empty(&self) -> bool {
155 self.messages.is_empty()
156 }
157
158 pub fn updated_at(&self) -> DateTime<Utc> {
159 self.updated_at
160 }
161
162 pub fn touch_updated_at(&mut self) {
163 self.updated_at = Utc::now();
164 }
165
166 pub fn summary(&self) -> Option<SharedString> {
167 self.summary.clone()
168 }
169
170 pub fn summary_or_default(&self) -> SharedString {
171 const DEFAULT: SharedString = SharedString::new_static("New Thread");
172 self.summary.clone().unwrap_or(DEFAULT)
173 }
174
175 pub fn set_summary(&mut self, summary: impl Into<SharedString>, cx: &mut Context<Self>) {
176 self.summary = Some(summary.into());
177 cx.emit(ThreadEvent::SummaryChanged);
178 }
179
180 pub fn message(&self, id: MessageId) -> Option<&Message> {
181 self.messages.iter().find(|message| message.id == id)
182 }
183
184 pub fn messages(&self) -> impl Iterator<Item = &Message> {
185 self.messages.iter()
186 }
187
188 pub fn is_streaming(&self) -> bool {
189 !self.pending_completions.is_empty()
190 }
191
192 pub fn tools(&self) -> &Arc<ToolWorkingSet> {
193 &self.tools
194 }
195
196 pub fn context_for_message(&self, id: MessageId) -> Option<Vec<ContextSnapshot>> {
197 let context = self.context_by_message.get(&id)?;
198 Some(
199 context
200 .into_iter()
201 .filter_map(|context_id| self.context.get(&context_id))
202 .cloned()
203 .collect::<Vec<_>>(),
204 )
205 }
206
207 pub fn pending_tool_uses(&self) -> Vec<&PendingToolUse> {
208 self.pending_tool_uses_by_id.values().collect()
209 }
210
211 pub fn tool_uses_for_message(&self, id: MessageId) -> Vec<ToolUse> {
212 let Some(tool_uses_for_message) = &self.tool_uses_by_message.get(&id) else {
213 return Vec::new();
214 };
215
216 // The tool use was requested by an Assistant message, so we need to
217 // look for the tool results on the next user message.
218 let next_user_message = MessageId(id.0 + 1);
219
220 let empty = Vec::new();
221 let tool_results_for_message = self
222 .tool_results_by_message
223 .get(&next_user_message)
224 .unwrap_or_else(|| &empty);
225
226 let mut tool_uses = Vec::new();
227
228 for tool_use in tool_uses_for_message.iter() {
229 let tool_result = tool_results_for_message
230 .iter()
231 .find(|tool_result| tool_result.tool_use_id == tool_use.id);
232
233 let status = (|| {
234 if let Some(tool_result) = tool_result {
235 return if tool_result.is_error {
236 ToolUseStatus::Error(tool_result.content.clone().into())
237 } else {
238 ToolUseStatus::Finished(tool_result.content.clone().into())
239 };
240 }
241
242 if let Some(pending_tool_use) = self.pending_tool_uses_by_id.get(&tool_use.id) {
243 return match pending_tool_use.status {
244 PendingToolUseStatus::Idle => ToolUseStatus::Pending,
245 PendingToolUseStatus::Running { .. } => ToolUseStatus::Running,
246 PendingToolUseStatus::Error(ref err) => {
247 ToolUseStatus::Error(err.clone().into())
248 }
249 };
250 }
251
252 ToolUseStatus::Pending
253 })();
254
255 tool_uses.push(ToolUse {
256 id: tool_use.id.clone(),
257 name: tool_use.name.clone().into(),
258 input: tool_use.input.clone(),
259 status,
260 })
261 }
262
263 tool_uses
264 }
265
266 pub fn insert_user_message(
267 &mut self,
268 text: impl Into<String>,
269 context: Vec<ContextSnapshot>,
270 cx: &mut Context<Self>,
271 ) {
272 let message_id = self.insert_message(Role::User, text, cx);
273 let context_ids = context.iter().map(|context| context.id).collect::<Vec<_>>();
274 self.context
275 .extend(context.into_iter().map(|context| (context.id, context)));
276 self.context_by_message.insert(message_id, context_ids);
277 }
278
279 pub fn insert_message(
280 &mut self,
281 role: Role,
282 text: impl Into<String>,
283 cx: &mut Context<Self>,
284 ) -> MessageId {
285 let id = self.next_message_id.post_inc();
286 self.messages.push(Message {
287 id,
288 role,
289 text: text.into(),
290 });
291 self.touch_updated_at();
292 cx.emit(ThreadEvent::MessageAdded(id));
293 id
294 }
295
296 /// Returns the representation of this [`Thread`] in a textual form.
297 ///
298 /// This is the representation we use when attaching a thread as context to another thread.
299 pub fn text(&self) -> String {
300 let mut text = String::new();
301
302 for message in &self.messages {
303 text.push_str(match message.role {
304 language_model::Role::User => "User:",
305 language_model::Role::Assistant => "Assistant:",
306 language_model::Role::System => "System:",
307 });
308 text.push('\n');
309
310 text.push_str(&message.text);
311 text.push('\n');
312 }
313
314 text
315 }
316
317 pub fn to_completion_request(
318 &self,
319 request_kind: RequestKind,
320 _cx: &App,
321 ) -> LanguageModelRequest {
322 let mut request = LanguageModelRequest {
323 messages: vec![],
324 tools: Vec::new(),
325 stop: Vec::new(),
326 temperature: None,
327 };
328
329 let mut referenced_context_ids = HashSet::default();
330
331 for message in &self.messages {
332 if let Some(context_ids) = self.context_by_message.get(&message.id) {
333 referenced_context_ids.extend(context_ids);
334 }
335
336 let mut request_message = LanguageModelRequestMessage {
337 role: message.role,
338 content: Vec::new(),
339 cache: false,
340 };
341 if let Some(tool_results) = self.tool_results_by_message.get(&message.id) {
342 match request_kind {
343 RequestKind::Chat => {
344 for tool_result in tool_results {
345 request_message
346 .content
347 .push(MessageContent::ToolResult(tool_result.clone()));
348 }
349 }
350 RequestKind::Summarize => {
351 // We don't care about tool use during summarization.
352 }
353 }
354 }
355
356 if !message.text.is_empty() {
357 request_message
358 .content
359 .push(MessageContent::Text(message.text.clone()));
360 }
361
362 if let Some(tool_uses) = self.tool_uses_by_message.get(&message.id) {
363 match request_kind {
364 RequestKind::Chat => {
365 for tool_use in tool_uses {
366 request_message
367 .content
368 .push(MessageContent::ToolUse(tool_use.clone()));
369 }
370 }
371 RequestKind::Summarize => {
372 // We don't care about tool use during summarization.
373 }
374 }
375 }
376
377 request.messages.push(request_message);
378 }
379
380 if !referenced_context_ids.is_empty() {
381 let mut context_message = LanguageModelRequestMessage {
382 role: Role::User,
383 content: Vec::new(),
384 cache: false,
385 };
386
387 let referenced_context = referenced_context_ids
388 .into_iter()
389 .filter_map(|context_id| self.context.get(context_id))
390 .cloned();
391 attach_context_to_message(&mut context_message, referenced_context);
392
393 request.messages.push(context_message);
394 }
395
396 request
397 }
398
399 pub fn stream_completion(
400 &mut self,
401 request: LanguageModelRequest,
402 model: Arc<dyn LanguageModel>,
403 cx: &mut Context<Self>,
404 ) {
405 let pending_completion_id = post_inc(&mut self.completion_count);
406
407 let task = cx.spawn(|thread, mut cx| async move {
408 let stream = model.stream_completion(request, &cx);
409 let stream_completion = async {
410 let mut events = stream.await?;
411 let mut stop_reason = StopReason::EndTurn;
412
413 while let Some(event) = events.next().await {
414 let event = event?;
415
416 thread.update(&mut cx, |thread, cx| {
417 match event {
418 LanguageModelCompletionEvent::StartMessage { .. } => {
419 thread.insert_message(Role::Assistant, String::new(), cx);
420 }
421 LanguageModelCompletionEvent::Stop(reason) => {
422 stop_reason = reason;
423 }
424 LanguageModelCompletionEvent::Text(chunk) => {
425 if let Some(last_message) = thread.messages.last_mut() {
426 if last_message.role == Role::Assistant {
427 last_message.text.push_str(&chunk);
428 cx.emit(ThreadEvent::StreamedAssistantText(
429 last_message.id,
430 chunk,
431 ));
432 } else {
433 // If we won't have an Assistant message yet, assume this chunk marks the beginning
434 // of a new Assistant response.
435 //
436 // Importantly: We do *not* want to emit a `StreamedAssistantText` event here, as it
437 // will result in duplicating the text of the chunk in the rendered Markdown.
438 thread.insert_message(Role::Assistant, chunk, cx);
439 }
440 }
441 }
442 LanguageModelCompletionEvent::ToolUse(tool_use) => {
443 if let Some(last_assistant_message) = thread
444 .messages
445 .iter()
446 .rfind(|message| message.role == Role::Assistant)
447 {
448 thread
449 .tool_uses_by_message
450 .entry(last_assistant_message.id)
451 .or_default()
452 .push(tool_use.clone());
453
454 thread.pending_tool_uses_by_id.insert(
455 tool_use.id.clone(),
456 PendingToolUse {
457 assistant_message_id: last_assistant_message.id,
458 id: tool_use.id,
459 name: tool_use.name,
460 input: tool_use.input,
461 status: PendingToolUseStatus::Idle,
462 },
463 );
464 }
465 }
466 }
467
468 thread.touch_updated_at();
469 cx.emit(ThreadEvent::StreamedCompletion);
470 cx.notify();
471 })?;
472
473 smol::future::yield_now().await;
474 }
475
476 thread.update(&mut cx, |thread, cx| {
477 thread
478 .pending_completions
479 .retain(|completion| completion.id != pending_completion_id);
480
481 if thread.summary.is_none() && thread.messages.len() >= 2 {
482 thread.summarize(cx);
483 }
484 })?;
485
486 anyhow::Ok(stop_reason)
487 };
488
489 let result = stream_completion.await;
490
491 thread
492 .update(&mut cx, |thread, cx| match result.as_ref() {
493 Ok(stop_reason) => match stop_reason {
494 StopReason::ToolUse => {
495 cx.emit(ThreadEvent::UsePendingTools);
496 }
497 StopReason::EndTurn => {}
498 StopReason::MaxTokens => {}
499 },
500 Err(error) => {
501 if error.is::<PaymentRequiredError>() {
502 cx.emit(ThreadEvent::ShowError(ThreadError::PaymentRequired));
503 } else if error.is::<MaxMonthlySpendReachedError>() {
504 cx.emit(ThreadEvent::ShowError(ThreadError::MaxMonthlySpendReached));
505 } else {
506 let error_message = error
507 .chain()
508 .map(|err| err.to_string())
509 .collect::<Vec<_>>()
510 .join("\n");
511 cx.emit(ThreadEvent::ShowError(ThreadError::Message(
512 SharedString::from(error_message.clone()),
513 )));
514 }
515
516 thread.cancel_last_completion();
517 }
518 })
519 .ok();
520 });
521
522 self.pending_completions.push(PendingCompletion {
523 id: pending_completion_id,
524 _task: task,
525 });
526 }
527
528 pub fn summarize(&mut self, cx: &mut Context<Self>) {
529 let Some(provider) = LanguageModelRegistry::read_global(cx).active_provider() else {
530 return;
531 };
532 let Some(model) = LanguageModelRegistry::read_global(cx).active_model() else {
533 return;
534 };
535
536 if !provider.is_authenticated(cx) {
537 return;
538 }
539
540 let mut request = self.to_completion_request(RequestKind::Summarize, cx);
541 request.messages.push(LanguageModelRequestMessage {
542 role: Role::User,
543 content: vec![
544 "Generate a concise 3-7 word title for this conversation, omitting punctuation. Go straight to the title, without any preamble and prefix like `Here's a concise suggestion:...` or `Title:`"
545 .into(),
546 ],
547 cache: false,
548 });
549
550 self.pending_summary = cx.spawn(|this, mut cx| {
551 async move {
552 let stream = model.stream_completion_text(request, &cx);
553 let mut messages = stream.await?;
554
555 let mut new_summary = String::new();
556 while let Some(message) = messages.stream.next().await {
557 let text = message?;
558 let mut lines = text.lines();
559 new_summary.extend(lines.next());
560
561 // Stop if the LLM generated multiple lines.
562 if lines.next().is_some() {
563 break;
564 }
565 }
566
567 this.update(&mut cx, |this, cx| {
568 if !new_summary.is_empty() {
569 this.summary = Some(new_summary.into());
570 }
571
572 cx.emit(ThreadEvent::SummaryChanged);
573 })?;
574
575 anyhow::Ok(())
576 }
577 .log_err()
578 });
579 }
580
581 pub fn insert_tool_output(
582 &mut self,
583 assistant_message_id: MessageId,
584 tool_use_id: LanguageModelToolUseId,
585 output: Task<Result<String>>,
586 cx: &mut Context<Self>,
587 ) {
588 let insert_output_task = cx.spawn(|thread, mut cx| {
589 let tool_use_id = tool_use_id.clone();
590 async move {
591 let output = output.await;
592 thread
593 .update(&mut cx, |thread, cx| {
594 // The tool use was requested by an Assistant message,
595 // so we want to attach the tool results to the next
596 // user message.
597 let next_user_message = MessageId(assistant_message_id.0 + 1);
598
599 let tool_results = thread
600 .tool_results_by_message
601 .entry(next_user_message)
602 .or_default();
603
604 match output {
605 Ok(output) => {
606 tool_results.push(LanguageModelToolResult {
607 tool_use_id: tool_use_id.clone(),
608 content: output,
609 is_error: false,
610 });
611 thread.pending_tool_uses_by_id.remove(&tool_use_id);
612
613 cx.emit(ThreadEvent::ToolFinished { tool_use_id });
614 }
615 Err(err) => {
616 tool_results.push(LanguageModelToolResult {
617 tool_use_id: tool_use_id.clone(),
618 content: err.to_string(),
619 is_error: true,
620 });
621
622 if let Some(tool_use) =
623 thread.pending_tool_uses_by_id.get_mut(&tool_use_id)
624 {
625 tool_use.status = PendingToolUseStatus::Error(err.to_string());
626 }
627 }
628 }
629 })
630 .ok();
631 }
632 });
633
634 if let Some(tool_use) = self.pending_tool_uses_by_id.get_mut(&tool_use_id) {
635 tool_use.status = PendingToolUseStatus::Running {
636 _task: insert_output_task.shared(),
637 };
638 }
639 }
640
641 /// Cancels the last pending completion, if there are any pending.
642 ///
643 /// Returns whether a completion was canceled.
644 pub fn cancel_last_completion(&mut self) -> bool {
645 if let Some(_last_completion) = self.pending_completions.pop() {
646 true
647 } else {
648 false
649 }
650 }
651}
652
653#[derive(Debug, Clone)]
654pub enum ThreadError {
655 PaymentRequired,
656 MaxMonthlySpendReached,
657 Message(SharedString),
658}
659
660#[derive(Debug, Clone)]
661pub enum ThreadEvent {
662 ShowError(ThreadError),
663 StreamedCompletion,
664 StreamedAssistantText(MessageId, String),
665 MessageAdded(MessageId),
666 SummaryChanged,
667 UsePendingTools,
668 ToolFinished {
669 #[allow(unused)]
670 tool_use_id: LanguageModelToolUseId,
671 },
672}
673
674impl EventEmitter<ThreadEvent> for Thread {}
675
676struct PendingCompletion {
677 id: usize,
678 _task: Task<()>,
679}
680
681#[derive(Debug, Clone)]
682pub struct PendingToolUse {
683 pub id: LanguageModelToolUseId,
684 /// The ID of the Assistant message in which the tool use was requested.
685 pub assistant_message_id: MessageId,
686 pub name: String,
687 pub input: serde_json::Value,
688 pub status: PendingToolUseStatus,
689}
690
691#[derive(Debug, Clone)]
692pub enum PendingToolUseStatus {
693 Idle,
694 Running { _task: Shared<Task<()>> },
695 Error(#[allow(unused)] String),
696}
697
698impl PendingToolUseStatus {
699 pub fn is_idle(&self) -> bool {
700 matches!(self, PendingToolUseStatus::Idle)
701 }
702}