Merge pull request #399 from batanus/add-annotations-to-chat-stream-result

Add annotations to chat stream result

Author: nezhyborets

Sources/OpenAI/Public/Models/Annotation.swift

@@ -0,0 +1,29 @@
+import Foundation
+
+public struct Annotation: Codable, Equatable, Sendable {
+    /// The type of the URL citation. Always `url_citation`.
+    public let type: String
+    /// A URL citation when using web search.
+    public let urlCitation: URLCitation
+
+    public enum CodingKeys: String, CodingKey {
+        case type, urlCitation = "url_citation"
+    }
+
+    public struct URLCitation: Codable, Equatable, Sendable {
+        /// The index of the last character of the URL citation in the message.
+        public let endIndex: Int
+        /// The index of the first character of the URL citation in the message.
+        public let startIndex: Int
+        /// The title of the web resource.
+        public let title: String
+        /// The URL of the web resource.
+        public let url: String
+
+        public enum CodingKeys: String, CodingKey {
+            case endIndex = "end_index"
+            case startIndex = "start_index"
+            case title, url
+        }
+    }
+}

Sources/OpenAI/Public/Models/ChatResult.swift

@@ -156,34 +156,6 @@ public struct ChatResult: Codable, Equatable, Sendable {
                 case _reasoningContent = "reasoning_content"
             }
 
-            public struct Annotation: Codable, Equatable, Sendable {
-                /// The type of the URL citation. Always `url_citation`.
-                let type: String
-                /// A URL citation when using web search.
-                let urlCitation: URLCitation
-                
-                public enum CodingKeys: String, CodingKey {
-                    case type, urlCitation = "url_citation"
-                }
-                
-                public struct URLCitation: Codable, Equatable, Sendable {
-                    /// The index of the last character of the URL citation in the message.
-                    let endIndex: Int
-                    /// The index of the first character of the URL citation in the message.
-                    let startIndex: Int
-                    /// The title of the web resource.
-                    let title: String
-                    /// The URL of the web resource.
-                    let url: String
-                    
-                    public enum CodingKeys: String, CodingKey {
-                        case endIndex = "end_index"
-                        case startIndex = "start_index"
-                        case title, url
-                    }
-                }
-            }
-            
             public struct Audio: Codable, Equatable, Sendable {
                 /// Base64 encoded audio bytes generated by the model, in the format specified in the request.
                 public let data: String

Sources/OpenAI/Public/Models/ChatStreamResult.swift

@@ -27,6 +27,9 @@ public struct ChatStreamResult: Codable, Equatable, Sendable {
             /// The role of the author of this message.
             public let role: Self.Role?
             public let toolCalls: [Self.ChoiceDeltaToolCall]?
+            /// Annotations for the message, when applicable, as when using the web search tool.
+            /// Web search tool: https://platform.openai.com/docs/guides/tools-web-search?api-mode=chat
+            public let annotations: [Annotation]?
 
             /// Value for `reasoning` field in response.
             ///
@@ -123,6 +126,7 @@ public struct ChatStreamResult: Codable, Equatable, Sendable {
                 case refusal
                 case audio
                 case role
+                case annotations
                 case toolCalls = "tool_calls"
                 case _reasoning = "reasoning"
                 case _reasoningContent = "reasoning_content"