Add Tool Interaction Views

Sources/SpeziChat/MessageView.swift

@@ -45,7 +45,7 @@
 
     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 @@
         }
     }
 
+    private var isToolInteraction: Bool {
+        switch chat.role {
+        case .assistantToolCall, .assistantToolResponse:
+            return true
+        default:
+            return 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 @@
             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(

Sources/SpeziChat/Models/ChatEntity+Alignment.swift

@@ -7,6 +7,7 @@
 //
 
 import Foundation
+import SwiftUI
 
 
 extension ChatEntity {
@@ -26,4 +27,13 @@ extension ChatEntity {
             return .leading
         }
     }
+
+    var horziontalAlignment: HorizontalAlignment {
+        switch self.alignment {
+        case .leading:
+            return .leading
+        case .trailing:
+            return .trailing
+        }
+    }
 }

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)"
             }
         }

Sources/SpeziChat/Resources/Localizable.xcstrings

@@ -20,6 +20,9 @@
           }
         }
       }
+    },
+    "Equal sign" : {
+
     },
     "EXPORT_CHAT_BUTTON" : {
       "localizations" : {
@@ -30,6 +33,9 @@
           }
         }
       }
+    },
+    "Function F of X" : {
+
     },
     "MESSAGE_INPUT_TEXTFIELD" : {
       "localizations" : {
@@ -75,6 +81,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" : {

Sources/SpeziChat/ToolInteractionView.swift

@@ -0,0 +1,73 @@
+//
+// This source file is part of the Stanford Spezi open source project
+//
+// SPDX-FileCopyrightText: 2024 Stanford University and the project authors (see CONTRIBUTORS.md)
+//
+// SPDX-License-Identifier: MIT
+//
+
+import SwiftUI
+
+/// The view that is represented when a tool call or tool reponse based on the ``ChatEntity/Role``.
+struct ToolInteractionView: View {
+    let entity: ChatEntity
+    @State private var isExpanded = false
+
+    var body: some View {
+        switch entity.role {
+        case .assistantToolCall:
+            toolCallView(content: entity.content)
+        case .assistantToolResponse:
+            toolResponseView(content: entity.content)
+        default:
+            EmptyView()
+        }
+    }
+
+    private func toolCallView(content: String) -> some View {
+        HStack {
+            Image(systemName: "function")
+                .accessibilityLabel("Function F of X")
+                .frame(width: 20)
+            Text(content)
+                .foregroundStyle(.secondary)
+                .font(.footnote)
+                .lineLimit(isExpanded ? nil : 0)
+        }
+        .padding(.horizontal, 10)
+        .padding(.top, 8)
+        .onTapGesture {
+            withAnimation {
+                isExpanded.toggle()
+            }
+        }
+    }
+
+    private func toolResponseView(content: String) -> some View {
+        HStack {
+            Image(systemName: "equal")
+                .accessibilityLabel("Equal sign")
+                .frame(width: 20)
+
+            Group {
+                if content.contains(where: \.isNewline) && !isExpanded {
+                    Text(String(localized: "SEE_MORE", bundle: .module))
+                        .italic()
+                } else {
+                    Text(content)
+                }
+            }
+            .foregroundStyle(.secondary)
+            .font(.footnote)
+            .lineLimit(isExpanded ? nil : 0)
+        }
+        .padding(.horizontal, 10)
+        .padding(.top, 8)
+        .padding(.bottom, 4)
+        .onTapGesture {
+            withAnimation {
+                isExpanded.toggle()
+            }
+        }
+    }
+}

Tests/UITests/TestAppUITests/TestAppUITests.swift

@@ -28,7 +28,7 @@
         XCTAssert(app.staticTexts["SpeziChat"].waitForExistence(timeout: 1))
         XCTAssert(app.staticTexts["Assistant Message!"].waitForExistence(timeout: 1))
 
-        try app.textViews["Message Input Textfield"].enter(value: "User Message!", dismissKeyboard: false)
+        try app.textFields["Message Input Textfield"].enter(value: "User Message!", dismissKeyboard: false)
         XCTAssert(app.buttons["Send Message"].waitForExistence(timeout: 5))
         app.buttons["Send Message"].tap()
 
@@ -48,7 +48,7 @@
         throw XCTSkip("VisionOS is unstable and are skipped at the moment")
         #endif
 
         let app = XCUIApplication()
         let filesApp = XCUIApplication(bundleIdentifier: "com.apple.DocumentsApp")
         let maxRetries = 10
 
@@ -60,7 +60,7 @@
 
             // Entering dummy chat value
             XCTAssert(app.staticTexts["SpeziChat"].waitForExistence(timeout: 1))
-            try app.textViews["Message Input Textfield"].enter(value: "User Message!", dismissKeyboard: false)
+            try app.textFields["Message Input Textfield"].enter(value: "User Message!", dismissKeyboard: false)
             XCTAssert(app.buttons["Send Message"].waitForExistence(timeout: 5))
             app.buttons["Send Message"].tap()