Merge pull request #294 from MacPaw/293-keynotfound-errors-since-v037

Make toolCalls and annotations optional

Author: nezhyborets

Demo/DemoChat/Sources/ChatStore.swift

@@ -66,7 +66,8 @@ public final class ChatStore: ObservableObject {
     func sendMessage(
         _ message: Message,
         conversationId: Conversation.ID,
-        model: Model
+        model: Model,
+        isStreamEnabled: Bool
     ) async {
         guard let conversationIndex = conversations.firstIndex(where: { $0.id == conversationId }) else {
             return
@@ -79,7 +80,7 @@ public final class ChatStore: ObservableObject {
             await completeChat(
                 conversationId: conversationId,
                 model: model,
-                stream: true
+                stream: isStreamEnabled
             )
             // For assistant case we send chats to thread and then poll, polling will receive sent chat + new assistant messages.
         case .assistant:

Demo/DemoChat/Sources/UI/ChatView.swift

@@ -53,7 +53,7 @@ public struct ChatView: View {
                     DetailView(
                         availableAssistants: assistantStore.availableAssistants, conversation: conversation,
                         error: store.conversationErrors[conversation.id],
-                        sendMessage: { message, selectedModel in
+                        sendMessage: { message, selectedModel, streamEnabled in
                             self.sendMessageTask = Task {
                                 await store.sendMessage(
                                     Message(
@@ -63,7 +63,8 @@ public struct ChatView: View {
                                         createdAt: dateProvider()
                                     ),
                                     conversationId: conversation.id,
-                                    model: selectedModel
+                                    model: selectedModel,
+                                    isStreamEnabled: streamEnabled
                                 )
                             }
                         }, isSendingMessage: $store.isSendingMessage

Demo/DemoChat/Sources/UI/DetailView.swift

@@ -18,13 +18,14 @@ struct DetailView: View {
     @FocusState private var isFocused: Bool
     @State private var showsModelSelectionSheet = false
     @State private var selectedChatModel: Model = .gpt4_o_mini
+    @State private var streamEnabled = true
     var availableAssistants: [Assistant]
 
     private static let availableChatModels: [Model] = [.gpt4_o_mini]
 
     let conversation: Conversation
     let error: Error?
-    let sendMessage: (String, Model) -> Void
+    let sendMessage: (String, Model, Bool) -> Void
 
     @Binding var isSendingMessage: Bool
 
@@ -76,7 +77,7 @@ struct DetailView: View {
                 .safeAreaInset(edge: .top) {
                     HStack {
                         Text(
-                            "Model: \(conversation.type == .assistant ? Model.gpt4_o_mini : selectedChatModel)"
+                            "Model: \(conversation.type == .assistant ? Model.gpt4_o_mini : selectedChatModel), stream: \(streamEnabled)"
                         )
                         .font(.caption)
                         .foregroundColor(.secondary)
@@ -123,6 +124,12 @@ struct DetailView: View {
                                 Text(model)
                             }
                         }
+                        
+                        Button {
+                            streamEnabled.toggle()
+                        } label: {
+                            Text(streamEnabled ? "Disable streaming" : "Enable streaming")
+                        }
 
                         Button("Cancel", role: .cancel) {
                             showsModelSelectionSheet = false
@@ -219,7 +226,7 @@ struct DetailView: View {
             return
         }
 
-        sendMessage(message, selectedChatModel)
+        sendMessage(message, selectedChatModel, streamEnabled)
         inputText = ""
 
 //        if let lastMessage = conversation.messages.last {
@@ -317,7 +324,7 @@ struct DetailView_Previews: PreviewProvider {
                 ]
             ),
             error: nil,
-            sendMessage: { _, _ in }, isSendingMessage: Binding.constant(false)
+            sendMessage: { _, _, _ in }, isSendingMessage: Binding.constant(false)
         )
     }
 }

Demo/DemoChat/Sources/UI/ModerationChatView.swift

@@ -21,7 +21,7 @@ public struct ModerationChatView: View {
         DetailView(
             availableAssistants: [], conversation: store.moderationConversation, 
             error: store.moderationConversationError,
-            sendMessage: { message, _ in
+            sendMessage: { message, _, _ in
                 Task {
                     await store.sendModerationMessage(
                         Message(

Sources/OpenAI/Public/Models/ChatResult.swift

@@ -26,14 +26,22 @@ public struct ChatResult: Codable, Equatable, Sendable {
             public let refusal: String?
             /// The role of the author of this message.
             public let role: String
+            
             /// 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]
+            ///
+            /// This field is declared non-optional in OpenAI API reference, but to not make breaking changes for our users that use this SDK for other providers like DeepSeek, made it optional for now
+            /// See https://github.com/MacPaw/OpenAI/issues/293
+            public let annotations: [Annotation]?
             /// If the audio output modality is requested, this object contains data about the audio response from the model.
             /// Learn more: https://platform.openai.com/docs/guides/audio
             public let audio: Audio?
+            
             /// The tool calls generated by the model, such as function calls.
-            public let toolCalls: [ChatQuery.ChatCompletionMessageParam.AssistantMessageParam.ToolCallParam]
+            ///
+            /// This field is declared not-optional in OpenAI API reference. But it seems that under some conditions it may not be present in a response.
+            /// See https://github.com/MacPaw/OpenAI/issues/293
+            public let toolCalls: [ChatQuery.ChatCompletionMessageParam.AssistantMessageParam.ToolCallParam]?
 
             /// Following are fields that are not part of OpenAI but are present in responses from other providers