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, LanguageModelRequestTool, LanguageModelToolResult,
13 LanguageModelToolUse, LanguageModelToolUseId, MaxMonthlySpendReachedError, MessageContent,
14 PaymentRequiredError, 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 message_has_tool_results(&self, message_id: MessageId) -> bool {
267 self.tool_results_by_message
268 .get(&message_id)
269 .map_or(false, |results| !results.is_empty())
270 }
271
272 pub fn insert_user_message(
273 &mut self,
274 text: impl Into<String>,
275 context: Vec<ContextSnapshot>,
276 cx: &mut Context<Self>,
277 ) {
278 let message_id = self.insert_message(Role::User, text, cx);
279 let context_ids = context.iter().map(|context| context.id).collect::<Vec<_>>();
280 self.context
281 .extend(context.into_iter().map(|context| (context.id, context)));
282 self.context_by_message.insert(message_id, context_ids);
283 }
284
285 pub fn insert_message(
286 &mut self,
287 role: Role,
288 text: impl Into<String>,
289 cx: &mut Context<Self>,
290 ) -> MessageId {
291 let id = self.next_message_id.post_inc();
292 self.messages.push(Message {
293 id,
294 role,
295 text: text.into(),
296 });
297 self.touch_updated_at();
298 cx.emit(ThreadEvent::MessageAdded(id));
299 id
300 }
301
302 /// Returns the representation of this [`Thread`] in a textual form.
303 ///
304 /// This is the representation we use when attaching a thread as context to another thread.
305 pub fn text(&self) -> String {
306 let mut text = String::new();
307
308 for message in &self.messages {
309 text.push_str(match message.role {
310 language_model::Role::User => "User:",
311 language_model::Role::Assistant => "Assistant:",
312 language_model::Role::System => "System:",
313 });
314 text.push('\n');
315
316 text.push_str(&message.text);
317 text.push('\n');
318 }
319
320 text
321 }
322
323 pub fn send_to_model(
324 &mut self,
325 model: Arc<dyn LanguageModel>,
326 request_kind: RequestKind,
327 use_tools: bool,
328 cx: &mut Context<Self>,
329 ) {
330 let mut request = self.to_completion_request(request_kind, cx);
331
332 if use_tools {
333 request.tools = self
334 .tools()
335 .tools(cx)
336 .into_iter()
337 .map(|tool| LanguageModelRequestTool {
338 name: tool.name(),
339 description: tool.description(),
340 input_schema: tool.input_schema(),
341 })
342 .collect();
343 }
344
345 self.stream_completion(request, model, cx);
346 }
347
348 pub fn to_completion_request(
349 &self,
350 request_kind: RequestKind,
351 _cx: &App,
352 ) -> LanguageModelRequest {
353 let mut request = LanguageModelRequest {
354 messages: vec![],
355 tools: Vec::new(),
356 stop: Vec::new(),
357 temperature: None,
358 };
359
360 let mut referenced_context_ids = HashSet::default();
361
362 for message in &self.messages {
363 if let Some(context_ids) = self.context_by_message.get(&message.id) {
364 referenced_context_ids.extend(context_ids);
365 }
366
367 let mut request_message = LanguageModelRequestMessage {
368 role: message.role,
369 content: Vec::new(),
370 cache: false,
371 };
372 if let Some(tool_results) = self.tool_results_by_message.get(&message.id) {
373 match request_kind {
374 RequestKind::Chat => {
375 for tool_result in tool_results {
376 request_message
377 .content
378 .push(MessageContent::ToolResult(tool_result.clone()));
379 }
380 }
381 RequestKind::Summarize => {
382 // We don't care about tool use during summarization.
383 }
384 }
385 }
386
387 if !message.text.is_empty() {
388 request_message
389 .content
390 .push(MessageContent::Text(message.text.clone()));
391 }
392
393 if let Some(tool_uses) = self.tool_uses_by_message.get(&message.id) {
394 match request_kind {
395 RequestKind::Chat => {
396 for tool_use in tool_uses {
397 request_message
398 .content
399 .push(MessageContent::ToolUse(tool_use.clone()));
400 }
401 }
402 RequestKind::Summarize => {
403 // We don't care about tool use during summarization.
404 }
405 }
406 }
407
408 request.messages.push(request_message);
409 }
410
411 if !referenced_context_ids.is_empty() {
412 let mut context_message = LanguageModelRequestMessage {
413 role: Role::User,
414 content: Vec::new(),
415 cache: false,
416 };
417
418 let referenced_context = referenced_context_ids
419 .into_iter()
420 .filter_map(|context_id| self.context.get(context_id))
421 .cloned();
422 attach_context_to_message(&mut context_message, referenced_context);
423
424 request.messages.push(context_message);
425 }
426
427 request
428 }
429
430 pub fn stream_completion(
431 &mut self,
432 request: LanguageModelRequest,
433 model: Arc<dyn LanguageModel>,
434 cx: &mut Context<Self>,
435 ) {
436 let pending_completion_id = post_inc(&mut self.completion_count);
437
438 let task = cx.spawn(|thread, mut cx| async move {
439 let stream = model.stream_completion(request, &cx);
440 let stream_completion = async {
441 let mut events = stream.await?;
442 let mut stop_reason = StopReason::EndTurn;
443
444 while let Some(event) = events.next().await {
445 let event = event?;
446
447 thread.update(&mut cx, |thread, cx| {
448 match event {
449 LanguageModelCompletionEvent::StartMessage { .. } => {
450 thread.insert_message(Role::Assistant, String::new(), cx);
451 }
452 LanguageModelCompletionEvent::Stop(reason) => {
453 stop_reason = reason;
454 }
455 LanguageModelCompletionEvent::Text(chunk) => {
456 if let Some(last_message) = thread.messages.last_mut() {
457 if last_message.role == Role::Assistant {
458 last_message.text.push_str(&chunk);
459 cx.emit(ThreadEvent::StreamedAssistantText(
460 last_message.id,
461 chunk,
462 ));
463 } else {
464 // If we won't have an Assistant message yet, assume this chunk marks the beginning
465 // of a new Assistant response.
466 //
467 // Importantly: We do *not* want to emit a `StreamedAssistantText` event here, as it
468 // will result in duplicating the text of the chunk in the rendered Markdown.
469 thread.insert_message(Role::Assistant, chunk, cx);
470 }
471 }
472 }
473 LanguageModelCompletionEvent::ToolUse(tool_use) => {
474 if let Some(last_assistant_message) = thread
475 .messages
476 .iter()
477 .rfind(|message| message.role == Role::Assistant)
478 {
479 thread
480 .tool_uses_by_message
481 .entry(last_assistant_message.id)
482 .or_default()
483 .push(tool_use.clone());
484
485 thread.pending_tool_uses_by_id.insert(
486 tool_use.id.clone(),
487 PendingToolUse {
488 assistant_message_id: last_assistant_message.id,
489 id: tool_use.id,
490 name: tool_use.name,
491 input: tool_use.input,
492 status: PendingToolUseStatus::Idle,
493 },
494 );
495 }
496 }
497 }
498
499 thread.touch_updated_at();
500 cx.emit(ThreadEvent::StreamedCompletion);
501 cx.notify();
502 })?;
503
504 smol::future::yield_now().await;
505 }
506
507 thread.update(&mut cx, |thread, cx| {
508 thread
509 .pending_completions
510 .retain(|completion| completion.id != pending_completion_id);
511
512 if thread.summary.is_none() && thread.messages.len() >= 2 {
513 thread.summarize(cx);
514 }
515 })?;
516
517 anyhow::Ok(stop_reason)
518 };
519
520 let result = stream_completion.await;
521
522 thread
523 .update(&mut cx, |thread, cx| match result.as_ref() {
524 Ok(stop_reason) => match stop_reason {
525 StopReason::ToolUse => {
526 cx.emit(ThreadEvent::UsePendingTools);
527 }
528 StopReason::EndTurn => {}
529 StopReason::MaxTokens => {}
530 },
531 Err(error) => {
532 if error.is::<PaymentRequiredError>() {
533 cx.emit(ThreadEvent::ShowError(ThreadError::PaymentRequired));
534 } else if error.is::<MaxMonthlySpendReachedError>() {
535 cx.emit(ThreadEvent::ShowError(ThreadError::MaxMonthlySpendReached));
536 } else {
537 let error_message = error
538 .chain()
539 .map(|err| err.to_string())
540 .collect::<Vec<_>>()
541 .join("\n");
542 cx.emit(ThreadEvent::ShowError(ThreadError::Message(
543 SharedString::from(error_message.clone()),
544 )));
545 }
546
547 thread.cancel_last_completion();
548 }
549 })
550 .ok();
551 });
552
553 self.pending_completions.push(PendingCompletion {
554 id: pending_completion_id,
555 _task: task,
556 });
557 }
558
559 pub fn summarize(&mut self, cx: &mut Context<Self>) {
560 let Some(provider) = LanguageModelRegistry::read_global(cx).active_provider() else {
561 return;
562 };
563 let Some(model) = LanguageModelRegistry::read_global(cx).active_model() else {
564 return;
565 };
566
567 if !provider.is_authenticated(cx) {
568 return;
569 }
570
571 let mut request = self.to_completion_request(RequestKind::Summarize, cx);
572 request.messages.push(LanguageModelRequestMessage {
573 role: Role::User,
574 content: vec![
575 "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:`"
576 .into(),
577 ],
578 cache: false,
579 });
580
581 self.pending_summary = cx.spawn(|this, mut cx| {
582 async move {
583 let stream = model.stream_completion_text(request, &cx);
584 let mut messages = stream.await?;
585
586 let mut new_summary = String::new();
587 while let Some(message) = messages.stream.next().await {
588 let text = message?;
589 let mut lines = text.lines();
590 new_summary.extend(lines.next());
591
592 // Stop if the LLM generated multiple lines.
593 if lines.next().is_some() {
594 break;
595 }
596 }
597
598 this.update(&mut cx, |this, cx| {
599 if !new_summary.is_empty() {
600 this.summary = Some(new_summary.into());
601 }
602
603 cx.emit(ThreadEvent::SummaryChanged);
604 })?;
605
606 anyhow::Ok(())
607 }
608 .log_err()
609 });
610 }
611
612 pub fn insert_tool_output(
613 &mut self,
614 assistant_message_id: MessageId,
615 tool_use_id: LanguageModelToolUseId,
616 output: Task<Result<String>>,
617 cx: &mut Context<Self>,
618 ) {
619 let insert_output_task = cx.spawn(|thread, mut cx| {
620 let tool_use_id = tool_use_id.clone();
621 async move {
622 let output = output.await;
623 thread
624 .update(&mut cx, |thread, cx| {
625 // The tool use was requested by an Assistant message,
626 // so we want to attach the tool results to the next
627 // user message.
628 let next_user_message = MessageId(assistant_message_id.0 + 1);
629
630 let tool_results = thread
631 .tool_results_by_message
632 .entry(next_user_message)
633 .or_default();
634
635 match output {
636 Ok(output) => {
637 tool_results.push(LanguageModelToolResult {
638 tool_use_id: tool_use_id.clone(),
639 content: output.into(),
640 is_error: false,
641 });
642 thread.pending_tool_uses_by_id.remove(&tool_use_id);
643
644 cx.emit(ThreadEvent::ToolFinished { tool_use_id });
645 }
646 Err(err) => {
647 tool_results.push(LanguageModelToolResult {
648 tool_use_id: tool_use_id.clone(),
649 content: err.to_string().into(),
650 is_error: true,
651 });
652
653 if let Some(tool_use) =
654 thread.pending_tool_uses_by_id.get_mut(&tool_use_id)
655 {
656 tool_use.status =
657 PendingToolUseStatus::Error(err.to_string().into());
658 }
659
660 cx.emit(ThreadEvent::ToolFinished { tool_use_id });
661 }
662 }
663 })
664 .ok();
665 }
666 });
667
668 if let Some(tool_use) = self.pending_tool_uses_by_id.get_mut(&tool_use_id) {
669 tool_use.status = PendingToolUseStatus::Running {
670 _task: insert_output_task.shared(),
671 };
672 }
673 }
674
675 /// Cancels the last pending completion, if there are any pending.
676 ///
677 /// Returns whether a completion was canceled.
678 pub fn cancel_last_completion(&mut self) -> bool {
679 if let Some(_last_completion) = self.pending_completions.pop() {
680 true
681 } else {
682 false
683 }
684 }
685}
686
687#[derive(Debug, Clone)]
688pub enum ThreadError {
689 PaymentRequired,
690 MaxMonthlySpendReached,
691 Message(SharedString),
692}
693
694#[derive(Debug, Clone)]
695pub enum ThreadEvent {
696 ShowError(ThreadError),
697 StreamedCompletion,
698 StreamedAssistantText(MessageId, String),
699 MessageAdded(MessageId),
700 SummaryChanged,
701 UsePendingTools,
702 ToolFinished {
703 #[allow(unused)]
704 tool_use_id: LanguageModelToolUseId,
705 },
706}
707
708impl EventEmitter<ThreadEvent> for Thread {}
709
710struct PendingCompletion {
711 id: usize,
712 _task: Task<()>,
713}
714
715#[derive(Debug, Clone)]
716pub struct PendingToolUse {
717 pub id: LanguageModelToolUseId,
718 /// The ID of the Assistant message in which the tool use was requested.
719 pub assistant_message_id: MessageId,
720 pub name: Arc<str>,
721 pub input: serde_json::Value,
722 pub status: PendingToolUseStatus,
723}
724
725#[derive(Debug, Clone)]
726pub enum PendingToolUseStatus {
727 Idle,
728 Running { _task: Shared<Task<()>> },
729 Error(#[allow(unused)] Arc<str>),
730}
731
732impl PendingToolUseStatus {
733 pub fn is_idle(&self) -> bool {
734 matches!(self, PendingToolUseStatus::Idle)
735 }
736
737 pub fn is_error(&self) -> bool {
738 matches!(self, PendingToolUseStatus::Error(_))
739 }
740}