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