[Horizon] Assist Introduction Updates CLX-1730 (#3496)

* Adding the thumbs-up/thumbs down for assist chat. [ignore-commit-lint]

* WIP [ignore-commit-lint]

* WIP

* WIP

* Adding Cedar API calls and making the CoursePageGoal more capable

* Adding some more options when viewing a page.

* Disabling line length violations

* Disabling line length violations

* Making it so we can reset the environment

* Making it so the course document goal actually does something

* Making the translate option a little more generic

* Removing the translation abilities for the moment

* Removing the translation abilities for the moment

* Code cleanup

* Just updating a prompt

* Addressing merge comments and improving the look of the assist chat

* Fixing lint

* Making it so you can press the back button while an assist message is in process and it cancels the request.

* Making it so if we have lots of course options, it only presents the first 5. Making more options available to documents

* Moving the related CourseDocument and CoursePage goals into a group

* Satisfying swiftlint

* Adding comments and section deliniation

* Fixing Localizable.xcstrings

* More code cleanup

* Fixing a build error

* Code Review

* Code Review

* Code Review

* fix: resolve memory leaks

* Fixing an empty response and back button not appearing in assist

* Fixing Goals

* Adding back error handling

* Adding back error handling

* Swiftlint fix

---------

Co-authored-by: szabinst <[email protected]>

Author: reabbotted

Core/Core/Common/CommonModels/API/API.swift

@@ -16,6 +16,7 @@
 // along with this program.  If not, see <https://www.gnu.org/licenses/>.
 //
 
+import Combine
 import Foundation
 
 public class API {

Core/Core/Features/Inbox/ComposeMessage/View/WrappingHStack.swift

@@ -22,17 +22,21 @@ public struct WrappingHStack<Model, V>: View where Model: Hashable, V: View {
     public typealias ViewGenerator = (Model) -> V
     var models: [Model]
     var viewGenerator: ViewGenerator
-    var horizontalSpacing: CGFloat = 5
-    var verticalSpacing: CGFloat = 5
+    var horizontalSpacing: CGFloat
+    var verticalSpacing: CGFloat
 
     @State private var totalHeight = CGFloat.zero
 
     public init(
         models: [Model],
+        horizontalSpacing: CGFloat = 5,
+        verticalSpacing: CGFloat = 5,
         viewGenerator: @escaping ViewGenerator
     ) {
         self.models = models
         self.viewGenerator = viewGenerator
+        self.horizontalSpacing = horizontalSpacing
+        self.verticalSpacing = horizontalSpacing
     }
 
     public var body: some View {

Horizon/Horizon/Resources/Localizable.xcstrings

@@ -210,6 +210,9 @@
     },
     "Cairo (+02:00/+03:00)" : {
 
+    },
+    "Can I answer any questions about this document for you?" : {
+
     },
     "Canberra (+10:00/+11:00)" : {
 
@@ -285,6 +288,9 @@
     },
     "Copenhagen (+01:00/+02:00)" : {
 
+    },
+    "Create a Quiz" : {
+
     },
     "Create message" : {
 
@@ -390,9 +396,6 @@
     },
     "Filter by person" : {
 
-    },
-    "Flash cards" : {
-
     },
     "Fortaleza (-03:00/-03:00)" : {
 
@@ -402,6 +405,9 @@
     },
     "Full Name can only be changed by your institution." : {
 
+    },
+    "Generate Flash Cards" : {
+
     },
     "Georgetown (-04:00/-04:00)" : {
 
@@ -435,6 +441,9 @@
     },
     "Hello, Career!" : {
 
+    },
+    "Hello! Which course you'd like to discuss today?" : {
+
     },
     "Helsinki (+02:00/+03:00)" : {
 
@@ -454,7 +463,7 @@
     "hours" : {
 
     },
-    "How can I help today?" : {
+    "How can I help you with this page?" : {
 
     },
     "Important" : {
@@ -504,9 +513,6 @@
     },
     "Kathmandu (+05:45/+05:45)" : {
 
-    },
-    "Key takeaways" : {
-
     },
     "Kolkata (+05:30)" : {
 
@@ -534,9 +540,6 @@
     },
     "Learn" : {
 
-    },
-    "Learner" : {
-
     },
     "Lima (-05:00/-05:00)" : {
 
@@ -648,9 +651,18 @@
     },
     "No" : {
 
+    },
+    "No additional information found." : {
+
+    },
+    "No key takeaways found." : {
+
     },
     "No notification activity yet." : {
 
+    },
+    "No summary found." : {
+
     },
     "Norfolk Island (+11:00/+12:00)" : {
 
@@ -758,9 +770,6 @@
     },
     "Quito (-05:00/-05:00)" : {
 
-    },
-    "Quiz" : {
-
     },
     "Rangoon (+06:30/+06:30)" : {
 
@@ -866,6 +875,12 @@
     },
     "Something went wrong" : {
 
+    },
+    "Sorry, can we try that again? Which course is it you'd like to discuss?" : {
+
+    },
+    "Sorry, I don't have an answer for that right now." : {
+
     },
     "Sort By" : {
 
@@ -896,9 +911,6 @@
     },
     "Submitted" : {
 
-    },
-    "Summarize" : {
-
     },
     "Support" : {
 
@@ -927,10 +939,10 @@
     "Tehran (+03:30/+03:30)" : {
 
     },
-    "Tell me more" : {
+    "Text" : {
 
     },
-    "Text" : {
+    "Thank you for your feedback!" : {
 
     },
     "There are no scored activities in this course." : {
@@ -1037,6 +1049,12 @@
     },
     "West Central Africa (+01:00)" : {
 
+    },
+    "What would you like to discuss about the course %@?" : {
+
+    },
+    "What would you like to discuss today?" : {
+
     },
     "Yakutsk (+09:00/+09:00)" : {
 

Horizon/Horizon/Sources/Features/Assist/AssistAssembly.swift

@@ -44,21 +44,19 @@ final class AssistAssembly {
         return navigationController
     }
 
-    static func makeChatBotInteractor(courseId: String? = nil, pageUrl: String? = nil, fileId: String? = nil) -> AssistChatInteractor {
-        if let courseId = courseId, let pageUrl = pageUrl {
-            return AssistChatInteractorLive(
-                courseId: courseId,
-                pageUrl: pageUrl
-            )
-        }
-        if let courseId = courseId, let fileId = fileId {
-            return AssistChatInteractorLive(
-                courseId: courseId,
-                fileId: fileId,
-                downloadFileInteractor: DownloadFileInteractorLive(courseID: courseId)
-            )
-        }
-        return AssistChatInteractorLive()
+    static func makeChatBotInteractor(
+        courseId: String? = nil,
+        pageUrl: String? = nil,
+        fileId: String? = nil
+    ) -> AssistChatInteractor {
+        AssistChatInteractorLive(
+            courseID: courseId,
+            fileID: fileId,
+            pageURL: pageUrl,
+            downloadFileInteractor: courseId.map {
+                DownloadFileInteractorLive(courseID: $0)
+            }
+        )
     }
 
     static func makeAIQuizView(

Horizon/Horizon/Sources/Features/Assist/AssistChat/Data/AssistChatAction.swift

@@ -20,8 +20,10 @@ import Core
 
 /// ChatBotActions are published to the  AssistChatInteractor. The Interactor reacts to the action and publishes one or more ChatBotResponses.
 enum AssistChatAction {
+    case begin
+
     /// the user is chatting with the bot
-    case chat(prompt: String = "", history: [AssistChatMessage] = [])
+    case chat(prompt: String?, history: [AssistChatMessage] = [])
 
     /// the user has selected a chip while viewing a file
     case chip(option: AssistChipOption, history: [AssistChatMessage] = [])

Horizon/Horizon/Sources/Features/Assist/AssistChat/Data/AssistChatMessage.swift

@@ -19,51 +19,85 @@
 import Foundation
 
 /// A message returned from the interactor
-struct AssistChatMessage: Codable, Equatable {
+struct AssistChatMessage {
 
     let id: UUID
 
     /// The prompt that was sent to the AI. Not shown to the user
     /// If set to null, then it is removed from the list of messages sent to the AI
     let prompt: String?
 
-    /// The text shown to the user in the history. This may be different from the prompt sent to the AI
-    let text: String
+    /// The text shown to the user on screen. This may be different from the prompt sent to the AI
+    let text: String?
 
     /// Whether or not this came from the AI
     let role: Role
 
-    init(botResponse: String) {
-        prompt = botResponse
-        text = botResponse
-        role = .Assistant
-        id = UUID()
+    /// A list of options that the user can select from.
+    let chipOptions: [AssistChipOption]?
+
+    let flashCards: [AssistChatFlashCard]?
+
+    let quizItems: [QuizItem]?
+
+    init(botResponse: String, chipOptions: [AssistChipOption] = []) {
+        self.init(
+            role: .Assistant,
+            prompt: botResponse,
+            text: botResponse,
+            chipOptions: chipOptions
+        )
     }
 
-    init(userResponse: String) {
-        prompt = userResponse
-        text = userResponse
-        role = .User
-        id = UUID()
+    /// The user has asked for FlashCards
+    init(flashCards: [AssistChatFlashCard]) {
+        self.init(
+            role: .Assistant,
+            flashCards: flashCards
+        )
     }
 
-    init(prompt: String?, text: String, role: Role = .User) {
-        self.prompt = prompt
-        self.text = text
-        id = UUID()
+    /// The user has asked for a quiz
+    init(quizItems: [QuizItem]) {
+        self.init(
+            role: .Assistant,
+            quizItems: quizItems
+        )
+    }
 
-        self.role = role
+    init(userResponse: String, prompt: String? = nil) {
+        self.init(
+            role: .User,
+            prompt: prompt ?? userResponse,
+            text: userResponse
+        )
     }
 
-    func encode(to encoder: Encoder) throws {
-        var container = encoder.container(keyedBy: CodingKeys.self)
-        try container.encode(prompt, forKey: .prompt)
-        try container.encode(text, forKey: .text)
-        try container.encode(role, forKey: .role)
+    private init(
+        role: Role,
+        prompt: String? = nil,
+        text: String? = nil,
+        chipOptions: [AssistChipOption] = [],
+        flashCards: [AssistChatFlashCard] = [],
+        quizItems: [QuizItem]? = nil
+    ) {
+        self.id = UUID()
+        self.role = role
+        self.prompt = prompt
+        self.text = text
+        self.chipOptions = chipOptions
+        self.flashCards = flashCards
+        self.quizItems = quizItems
     }
 
     enum Role: String, Codable, Equatable {
         case Assistant
         case User
     }
+
+    struct QuizItem: Codable, Equatable {
+        let question: String
+        let answers: [String]
+        let correctAnswerIndex: Int
+    }
 }