Add references to chat message

Author: intitni

Core/Sources/ChatGPTChatTab/Chat.swift

@@ -15,11 +15,13 @@ public struct DisplayedChatMessage: Equatable {
     public var id: String
     public var role: Role
     public var text: String
+    public var references: [ChatMessage.Reference] = []
 
-    public init(id: String, role: Role, text: String) {
+    public init(id: String, role: Role, text: String, references: [ChatMessage.Reference]) {
         self.id = id
         self.role = role
         self.text = text
+        self.references = references
     }
 }
 
@@ -247,7 +249,8 @@ struct Chat: ReducerProtocol {
                             case .function: return .function
                             }
                         }(),
-                        text: message.summary ?? message.content ?? ""
+                        text: message.summary ?? message.content ?? "",
+                        references: message.references
                     )
                 }
 

Tool/Sources/OpenAIService/Models.swift

@@ -1,3 +1,4 @@
+import CodableWrappers
 import Foundation
 
 struct Cancellable {
@@ -24,9 +25,32 @@ public struct ChatMessage: Equatable, Codable {
         }
     }
 
+    public struct Reference: Codable, Equatable {
+        public var title: String
+        public var subTitle: String
+        public var uri: String
+        public var startLine: Int?
+        public var endLine: Int?
+        public var metadata: [String: String]
+
+        public init(
+            title: String,
+            subTitle: String,
+            uri: String,
+            startLine: Int?,
+            endLine: Int?,
+            metadata: [String: String]
+        ) {
+            self.title = title
+            self.subTitle = subTitle
+            self.uri = uri
+            self.metadata = metadata
+        }
+    }
+
     /// The role of a message.
     public var role: Role
-    
+
     /// The content of the message, either the chat message, or a result of a function call.
     public var content: String? {
         didSet { tokensCount = nil }
@@ -41,16 +65,20 @@ public struct ChatMessage: Equatable, Codable {
     public var name: String? {
         didSet { tokensCount = nil }
     }
-    
+
     /// The summary of a message that is used for display.
     public var summary: String?
-    
+
     /// The id of the message.
     public var id: String
-    
+
     /// The number of tokens of this message.
     var tokensCount: Int?
-    
+
+    /// The references of this message.
+    @FallbackDecoding<EmptyArray<Reference>>
+    public var references: [Reference]
+
     /// Is the message considered empty.
     var isEmpty: Bool {
         if let content, !content.isEmpty { return false }
@@ -66,7 +94,8 @@ public struct ChatMessage: Equatable, Codable {
         name: String? = nil,
         functionCall: FunctionCall? = nil,
         summary: String? = nil,
-        tokenCount: Int? = nil
+        tokenCount: Int? = nil,
+        references: [Reference] = []
     ) {
         self.role = role
         self.content = content
@@ -75,6 +104,7 @@ public struct ChatMessage: Equatable, Codable {
         self.summary = summary
         self.id = id
         tokensCount = tokenCount
+        self.references = references
     }
 }