Add Tool Interaction Views (#18)

StanfordSpezi · Dec 12, 2024 · 2fa1a93 · 2fa1a93
1 parent 940ffbe
commit 2fa1a93
Show file tree

Hide file tree

Showing 13 changed files with 278 additions and 29 deletions.
diff --git a/Sources/SpeziChat/ChatView+SpeechButton.swift b/Sources/SpeziChat/ChatView+SpeechButton.swift
@@ -86,14 +86,14 @@ extension View {
 
 #if DEBUG
 #Preview {
-    @State var chat: Chat = .init(
+    @Previewable @State var chat: Chat = .init(
         [
             ChatEntity(role: .user, content: "User Message!"),
             ChatEntity(role: .hidden(type: .unknown), content: "Hidden Message!"),
             ChatEntity(role: .assistant, content: "Assistant Message!")
         ]
     )
-    @State var muted = true
+    @Previewable @State var muted = true
 
 
     return NavigationStack {

diff --git a/Sources/SpeziChat/ChatView+SpeechOutput.swift b/Sources/SpeziChat/ChatView+SpeechOutput.swift
@@ -115,7 +115,7 @@ extension View {
 
 #if DEBUG
 #Preview("ChatView") {
-    @State var chat: Chat = .init(
+    @Previewable @State var chat: Chat = .init(
         [
             ChatEntity(role: .user, content: "User Message!"),
             ChatEntity(role: .hidden(type: .unknown), content: "Hidden Message!"),
@@ -129,12 +129,12 @@ extension View {
 }
 
 #Preview("ChatViewSpeechOutput") {
-    @State var chat: Chat = .init(
+    @Previewable @State var chat: Chat = .init(
         [
             ChatEntity(role: .assistant, content: "Assistant Message!")
         ]
     )
-    @State var muted = false
+    @Previewable @State var muted = false
 
 
     return NavigationStack {
@@ -144,12 +144,12 @@ extension View {
 }
 
 #Preview("ChatViewSpeechOutputDisabled") {
-    @State var chat: Chat = .init(
+    @Previewable @State var chat: Chat = .init(
         [
             ChatEntity(role: .assistant, content: "Assistant Message!")
         ]
     )
-    @State var muted = true
+    @Previewable @State var muted = true
 
 
     return NavigationStack {

diff --git a/Sources/SpeziChat/MessageInputView.swift b/Sources/SpeziChat/MessageInputView.swift
@@ -225,7 +225,7 @@ public struct MessageInputView: View {
 
 #if DEBUG
 #Preview {
-    @State var chat = [
+    @Previewable @State var chat = [
         ChatEntity(role: .user, content: "User Message!"),
         ChatEntity(role: .hidden(type: .unknown), content: "Hidden Message!"),
         ChatEntity(role: .assistant, content: "Assistant Message!")

diff --git a/Sources/SpeziChat/MessageView.swift b/Sources/SpeziChat/MessageView.swift
@@ -45,7 +45,7 @@ public struct MessageView: View {
 
     private var shouldDisplayMessage: Bool {
         switch chat.role {
-        case .user, .assistant: return true
+        case .user, .assistant, .assistantToolCall, .assistantToolResponse: return true
         case .hidden(let type):
             if case .custom(let hiddenMessageTypes) = hideMessages {
                 return !hiddenMessageTypes.contains(type)
@@ -55,14 +55,30 @@ public struct MessageView: View {
         }
     }
 
+    private var isToolInteraction: Bool {
+        switch chat.role {
+        case .assistantToolCall, .assistantToolResponse:
+            true
+        default:
+            false
+        }
+    }
+
     public var body: some View {
         if shouldDisplayMessage {
             HStack {
                 if chat.alignment == .trailing {
                     Spacer(minLength: 32)
                 }
-                Text(chat.attributedContent)
-                    .chatMessageStyle(alignment: chat.alignment)
+                VStack(alignment: chat.horziontalAlignment) {
+                    if isToolInteraction {
+                        ToolInteractionView(entity: chat)
+                    } else {
+                        Text(chat.attributedContent)
+                            .chatMessageStyle(alignment: chat.alignment)
+                    }
+                }
+
                 if chat.alignment == .leading {
                     Spacer(minLength: 32)
                 }
@@ -89,6 +105,12 @@ public struct MessageView: View {
             MessageView(ChatEntity(role: .assistant, content: "Assistant Message!"))
             MessageView(ChatEntity(role: .user, content: "Long User Message that spans over two lines!"))
             MessageView(ChatEntity(role: .assistant, content: "Long Assistant Message that spans over two lines!"))
+            MessageView(ChatEntity(role: .assistantToolCall, content: "assistent_too_call(parameter: value)"))
+            MessageView(ChatEntity(role: .assistantToolResponse, content: """
+            {
+                "some": "response"
+            }
+            """))
             MessageView(ChatEntity(role: .hidden(type: .unknown), content: "Hidden message! (invisible)"))
             MessageView(
                 ChatEntity(

diff --git a/Sources/SpeziChat/MessagesView.swift b/Sources/SpeziChat/MessagesView.swift
@@ -175,6 +175,8 @@ public struct MessagesView: View {
         [
             ChatEntity(role: .user, content: "User Message!"),
             ChatEntity(role: .hidden(type: .unknown), content: "Hidden Message (but still visible)!"),
+            ChatEntity(role: .assistantToolCall, content: "Assistant Message!"),
+            ChatEntity(role: .assistantToolResponse, content: "Assistant Message!f jiodsjfiods \n fudshfdusi"),
             ChatEntity(role: .assistant, content: "Assistant Message!")
         ],
         hideMessages: .custom(hiddenMessageTypes: [])

diff --git a/Sources/SpeziChat/Models/ChatEntity+Alignment.swift b/Sources/SpeziChat/Models/ChatEntity+Alignment.swift
@@ -7,6 +7,7 @@
 //
 
 import Foundation
+import SwiftUI
 
 
 extension ChatEntity {
@@ -21,9 +22,18 @@ extension ChatEntity {
     var alignment: Alignment {
         switch self.role {
         case .user:
-            return .trailing
+            .trailing
         default:
-            return .leading
+            .leading
+        }
+    }
+
+    var horziontalAlignment: HorizontalAlignment {
+        switch self.alignment {
+        case .leading:
+            .leading
+        case .trailing:
+            .trailing
         }
     }
 }
diff --git a/Sources/SpeziChat/Models/ChatEntity.swift b/Sources/SpeziChat/Models/ChatEntity.swift
@@ -19,13 +19,17 @@ public struct ChatEntity: Codable, Equatable, Hashable, Identifiable {
     public enum Role: Codable, Equatable, Hashable {
         case user
         case assistant
+        case assistantToolCall
+        case assistantToolResponse
         case hidden(type: ChatEntity.HiddenMessageType)
 
 
         var rawValue: String {
             switch self {
             case .user: "user"
             case .assistant: "assistant"
+            case .assistantToolCall: "assistant_tool_call"
+            case .assistantToolResponse: "assistant_tool_response"
             case .hidden(let type): "hidden_\(type.name)"
             }
         }

diff --git a/Sources/SpeziChat/Resources/Localizable.xcstrings b/Sources/SpeziChat/Resources/Localizable.xcstrings
@@ -21,13 +21,69 @@
         }
       }
     },
+    "EQUAL_SIGN" : {
+      "localizations" : {
+        "de" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "Gleichzeichen"
+          }
+        },
+        "en" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "Equal Sign"
+          }
+        },
+        "es" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "Signo igual"
+          }
+        }
+      }
+    },
     "EXPORT_CHAT_BUTTON" : {
       "localizations" : {
+        "de" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "Chat exportieren"
+          }
+        },
         "en" : {
           "stringUnit" : {
             "state" : "translated",
             "value" : "Export the Chat"
           }
+        },
+        "es" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "Exportar el chat"
+          }
+        }
+      }
+    },
+    "FUNCTION_F_OF_X" : {
+      "localizations" : {
+        "de" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "Funktion F von X"
+          }
+        },
+        "en" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "Function F of X"
+          }
+        },
+        "es" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "Función F de X"
+          }
         }
       }
     },
@@ -75,6 +131,28 @@
         }
       }
     },
+    "SEE_MORE" : {
+      "localizations" : {
+        "de" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "Details anzeigen"
+          }
+        },
+        "en" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "Show Details"
+          }
+        },
+        "es" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "Ver detalles"
+          }
+        }
+      }
+    },
     "SEND_MESSAGE" : {
       "localizations" : {
         "de" : {
@@ -98,18 +176,56 @@
       }
     },
     "Text to speech is disabled, press to enable text to speech." : {
-
+      "localizations" : {
+        "de" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "Die Spracheingabe ist deaktiviert, tippe um die Eingabe zu aktivieren."
+          }
+        },
+        "es" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "La función de texto a voz está desactivada, pulse para activarla."
+          }
+        }
+      }
     },
     "Text to speech is enabled, press to disable text to speech." : {
-
+      "localizations" : {
+        "de" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "Die Spracheingabe is aktiviert, tippe um die Eingabe zu dekativieren"
+          }
+        },
+        "es" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "La función de texto a voz está activada, pulse para desactivarla."
+          }
+        }
+      }
     },
     "TYPING_INDICATOR" : {
       "localizations" : {
+        "de" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "Schreibanzeige"
+          }
+        },
         "en" : {
           "stringUnit" : {
             "state" : "translated",
             "value" : "Typing Indicator"
           }
+        },
+        "es" : {
+          "stringUnit" : {
+            "state" : "translated",
+            "value" : "Indicador de mecanografía"
+          }
         }
       }
     }