Add feedback

Author: artemnovichkov

Sources/TranscriptDebugMenu/TranscriptDebugMenu.swift

@@ -9,12 +9,13 @@ import AppKit
 #endif
 import SwiftUI
 import FoundationModels
+import OSLog
 
-/// A SwiftUI view that displays a debug menu for viewing and copying `LanguageModelSession` transcripts.
+/// A SwiftUI view for inspecting, copying, and capturing feedback for `LanguageModelSession` transcripts.
 ///
-/// `TranscriptDebugMenu` provides a list interface for inspecting
-/// language model session transcripts. Each transcript entry can be viewed and copied to the
-/// clipboard using a context menu.
+/// `TranscriptDebugMenu` shows transcript entries in a list with a context menu to copy any entry.
+/// It also lets you mark the conversation sentiment and automatically
+/// generates a `LanguageModelFeedbackAttachment` JSON file that can be submitted to Apple using [Feedback Assistant](https://feedbackassistant.apple.com/).
 ///
 /// ## Usage
 ///
@@ -38,10 +39,18 @@ import FoundationModels
 ///}
 /// ```
 public struct TranscriptDebugMenu: View {
-
     /// The language model session containing the transcript to display.
     let session: LanguageModelSession
 
+    private let feedbackFileURL: URL = FileManager.default
+        .temporaryDirectory
+        .appendingPathComponent(UUID().uuidString)
+        .appendingPathExtension("json")
+
+    @State private var sentiment: LanguageModelFeedbackAttachment.Sentiment?
+    @State private var feedbackDataFileSaved: Bool = false
+    private let logger = Logger(subsystem: "com.artemnovichkov.TranscriptDebugMenu", category: "TranscriptDebugMenu")
+
     /// Creates a new transcript debug menu for the specified session.
     ///
     /// - Parameter session: The `LanguageModelSession` whose transcript will be displayed.
@@ -69,11 +78,62 @@ public struct TranscriptDebugMenu: View {
             }
             .overlay {
                 if session.transcript.isEmpty {
-                    ContentUnavailableView("No entries", systemImage: "apple.intelligence", description: Text("The transcript is empty"))
+                    ContentUnavailableView("No entries",
+                                           systemImage: "apple.intelligence",
+                                           description: Text("The transcript is empty"))
 
                 }
             }
             .navigationTitle("Transcript")
+            .toolbar {
+                toolbar
+            }
+            .onAppear {
+                saveFeedbackAttachment(sentiment: sentiment)
+            }
+            .onChange(of: sentiment) { _, newValue in
+                saveFeedbackAttachment(sentiment: newValue)
+            }
+        }
+    }
+
+    // MARK: - Private
+
+    @ToolbarContentBuilder
+    private var toolbar: some ToolbarContent {
+        ToolbarItem {
+            Button {
+                sentiment = sentiment == .negative ? nil : .negative
+            } label: {
+                Label("Negative",
+                      systemImage: "hand.thumbsdown" + (sentiment == .negative ? ".fill" : ""))
+            }
+        }
+        ToolbarItem {
+            Button {
+                sentiment = sentiment == .positive ? nil : .positive
+            } label: {
+                Label("Positive",
+                      systemImage: "hand.thumbsup" + (sentiment == .positive ? ".fill" : "" ))
+            }
+        }
+        ToolbarSpacer()
+        ToolbarItem {
+            ShareLink(item: feedbackFileURL)
+                .disabled(!feedbackDataFileSaved)
+        }
+    }
+
+    /// Generates a `LanguageModelFeedbackAttachment` from the current `session` and `sentiment`,
+    /// writes it as JSON to `feedbackFileURL`, and updates `fileSaved` accordingly.
+    private func saveFeedbackAttachment(sentiment: LanguageModelFeedbackAttachment.Sentiment?) {
+        let feedbackData = session.logFeedbackAttachment(sentiment: sentiment)
+        do {
+            try feedbackData.write(to: feedbackFileURL)
+            feedbackDataFileSaved = true
+        } catch {
+            feedbackDataFileSaved = false
+            logger.error("Failed to save feedback attachment: \(error.localizedDescription)")
         }
     }
 }

docs/data/documentation/transcriptdebugmenu.json

@@ -88,7 +88,7 @@
 "doc://TranscriptDebugMenu/documentation/TranscriptDebugMenu/TranscriptDebugMenu": {
   "abstract" : [
     {
-      "text" : "A SwiftUI view that displays a debug menu for viewing and copying ",
+      "text" : "A SwiftUI view for inspecting, copying, and capturing feedback for ",
       "type" : "text"
     },
     {

docs/data/documentation/transcriptdebugmenu/transcriptdebugmenu.json

@@ -1,7 +1,7 @@
 {
   "abstract" : [
     {
-      "text" : "A SwiftUI view that displays a debug menu for viewing and copying ",
+      "text" : "A SwiftUI view for inspecting, copying, and capturing feedback for ",
       "type" : "text"
     },
     {
@@ -113,23 +113,40 @@
               "type" : "codeVoice"
             },
             {
-              "text" : " provides a list interface for inspecting",
+              "text" : " shows transcript entries in a list with a context menu to copy any entry.",
               "type" : "text"
             },
             {
               "text" : " ",
               "type" : "text"
             },
             {
-              "text" : "language model session transcripts. Each transcript entry can be viewed and copied to the",
+              "text" : "It also lets you mark the conversation sentiment and automatically",
               "type" : "text"
             },
             {
               "text" : " ",
               "type" : "text"
             },
             {
-              "text" : "clipboard using a context menu.",
+              "text" : "generates a ",
+              "type" : "text"
+            },
+            {
+              "code" : "LanguageModelFeedbackAttachment",
+              "type" : "codeVoice"
+            },
+            {
+              "text" : " JSON file that can be submitted to Apple using ",
+              "type" : "text"
+            },
+            {
+              "identifier" : "https:\/\/feedbackassistant.apple.com\/",
+              "isActive" : true,
+              "type" : "reference"
+            },
+            {
+              "text" : ".",
               "type" : "text"
             }
           ],
@@ -248,7 +265,7 @@
 "doc://TranscriptDebugMenu/documentation/TranscriptDebugMenu/TranscriptDebugMenu": {
   "abstract" : [
     {
-      "text" : "A SwiftUI view that displays a debug menu for viewing and copying ",
+      "text" : "A SwiftUI view for inspecting, copying, and capturing feedback for ",
       "type" : "text"
     },
     {
@@ -390,6 +407,18 @@
   "identifier" : "doc:\/\/TranscriptDebugMenu\/s8SendableP",
   "title" : "Swift.Sendable",
   "type" : "unresolvable"
+},
+"https://feedbackassistant.apple.com/": {
+  "identifier" : "https:\/\/feedbackassistant.apple.com\/",
+  "title" : "Feedback Assistant",
+  "titleInlineContent" : [
+    {
+      "text" : "Feedback Assistant",
+      "type" : "text"
+    }
+  ],
+  "type" : "link",
+  "url" : "https:\/\/feedbackassistant.apple.com\/"
 }
 }
 }

docs/data/documentation/transcriptdebugmenu/transcriptdebugmenu/accentcolor(_:).json

@@ -259,7 +259,7 @@
 "doc://TranscriptDebugMenu/documentation/TranscriptDebugMenu/TranscriptDebugMenu": {
   "abstract" : [
     {
-      "text" : "A SwiftUI view that displays a debug menu for viewing and copying ",
+      "text" : "A SwiftUI view for inspecting, copying, and capturing feedback for ",
       "type" : "text"
     },
     {

docs/data/documentation/transcriptdebugmenu/transcriptdebugmenu/accessibility(activationpoint:)-1cpab.json

@@ -270,7 +270,7 @@
 "doc://TranscriptDebugMenu/documentation/TranscriptDebugMenu/TranscriptDebugMenu": {
   "abstract" : [
     {
-      "text" : "A SwiftUI view that displays a debug menu for viewing and copying ",
+      "text" : "A SwiftUI view for inspecting, copying, and capturing feedback for ",
       "type" : "text"
     },
     {

docs/data/documentation/transcriptdebugmenu/transcriptdebugmenu/accessibility(activationpoint:)-25mio.json

@@ -270,7 +270,7 @@
 "doc://TranscriptDebugMenu/documentation/TranscriptDebugMenu/TranscriptDebugMenu": {
   "abstract" : [
     {
-      "text" : "A SwiftUI view that displays a debug menu for viewing and copying ",
+      "text" : "A SwiftUI view for inspecting, copying, and capturing feedback for ",
       "type" : "text"
     },
     {

docs/data/documentation/transcriptdebugmenu/transcriptdebugmenu/accessibility(addtraits:).json

@@ -278,7 +278,7 @@
 "doc://TranscriptDebugMenu/documentation/TranscriptDebugMenu/TranscriptDebugMenu": {
   "abstract" : [
     {
-      "text" : "A SwiftUI view that displays a debug menu for viewing and copying ",
+      "text" : "A SwiftUI view for inspecting, copying, and capturing feedback for ",
       "type" : "text"
     },
     {

docs/data/documentation/transcriptdebugmenu/transcriptdebugmenu/accessibility(hidden:).json

@@ -270,7 +270,7 @@
 "doc://TranscriptDebugMenu/documentation/TranscriptDebugMenu/TranscriptDebugMenu": {
   "abstract" : [
     {
-      "text" : "A SwiftUI view that displays a debug menu for viewing and copying ",
+      "text" : "A SwiftUI view for inspecting, copying, and capturing feedback for ",
       "type" : "text"
     },
     {

docs/data/documentation/transcriptdebugmenu/transcriptdebugmenu/accessibility(hint:).json

@@ -270,7 +270,7 @@
 "doc://TranscriptDebugMenu/documentation/TranscriptDebugMenu/TranscriptDebugMenu": {
   "abstract" : [
     {
-      "text" : "A SwiftUI view that displays a debug menu for viewing and copying ",
+      "text" : "A SwiftUI view for inspecting, copying, and capturing feedback for ",
       "type" : "text"
     },
     {

docs/data/documentation/transcriptdebugmenu/transcriptdebugmenu/accessibility(identifier:).json

@@ -270,7 +270,7 @@
 "doc://TranscriptDebugMenu/documentation/TranscriptDebugMenu/TranscriptDebugMenu": {
   "abstract" : [
     {
-      "text" : "A SwiftUI view that displays a debug menu for viewing and copying ",
+      "text" : "A SwiftUI view for inspecting, copying, and capturing feedback for ",
       "type" : "text"
     },
     {