Merge pull request #11 from Compiler-Inc/fix/chunk-issues

Add tool call support

Author: AtharvaVaidya

Sources/CompilerSwiftAI/Model Calling/Domain Models/ChatCompletionChunk.swift

@@ -56,4 +56,31 @@ public struct ChatDelta: Decodable, Sendable {
     public let role: ChatRole?
     /// The content added in this chunk (if any).
     public let content: String?
+    /// The tool calls delta in this chunk (if any).
+    public let toolCalls: [ToolCallDelta]?
+    
+    enum CodingKeys: String, CodingKey {
+        case role, content
+        case toolCalls = "tool_calls"
+    }
+}
+
+/// Represents a delta for a tool call in a streamed response
+public struct ToolCallDelta: Decodable, Sendable {
+    /// The index of this tool call in the array
+    public let index: Int
+    /// The ID of the tool call (only present in first delta)
+    public let id: String?
+    /// The type of the tool call (only present in first delta)
+    public let type: String?
+    /// The function call delta
+    public let function: FunctionCallDelta?
+}
+
+/// Represents a delta for a function call in a streamed response
+public struct FunctionCallDelta: Decodable, Sendable {
+    /// The name of the function (only present in first delta)
+    public let name: String?
+    /// The arguments being built up
+    public let arguments: String?
 }

Sources/CompilerSwiftAI/Model Calling/Domain Models/ChatCompletionResponse.swift

@@ -53,16 +53,42 @@ public struct ChatMessage: Decodable, Sendable {
     /// The role of the message sender (for example, "assistant", "user", or "system").
     public let role: ChatRole
     /// The content of the message.
-    public let content: String
+    public let content: String?
     /// An optional refusal message (if applicable).
     public let refusal: String?
+    /// The tool calls made by the model in this message.
+    public let toolCalls: [ToolCall]?
+    
+    enum CodingKeys: String, CodingKey {
+        case role, content, refusal
+        case toolCalls = "tool_calls"
+    }
 }
 
 /// The role of a chat message.
 public enum ChatRole: String, Decodable, Sendable {
     case system
     case user
     case assistant
+    case tool
+}
+
+/// Represents a tool call made by the model
+public struct ToolCall: Decodable, Sendable {
+    /// A unique identifier for the tool call
+    public let id: String
+    /// The type of tool call (currently only "function" is supported)
+    public let type: String
+    /// The function that was called
+    public let function: FunctionCall
+}
+
+/// Represents a function call made by the model
+public struct FunctionCall: Decodable, Sendable {
+    /// The name of the function to call
+    public let name: String
+    /// The arguments to pass to the function, encoded as a JSON string
+    public let arguments: String
 }
 
 // MARK: - Usage and Token Details

Sources/CompilerSwiftAI/Model Calling/Domain Models/CompletionRequest.swift

@@ -53,7 +53,13 @@ public struct CompletionRequest {
 
     /// A unique identifier representing your end user.
     public let user: String?
-
+    
+    /// Tools (including functions) that the model may call.
+    public let tools: [Tool]?
+    
+    /// Controls which (if any) function is called by the model.
+    public let toolChoice: ToolChoice?
+    
     // MARK: - Initialization
 
     public init(
@@ -71,7 +77,9 @@ public struct CompletionRequest {
         stop: StopSequence? = nil,
         temperature: Double? = nil,
         topP: Double? = nil,
-        user: String? = nil
+        user: String? = nil,
+        tools: [Tool]? = nil,
+        toolChoice: ToolChoice? = nil
     ) {
         self.messages = messages
         self.model = model
@@ -88,6 +96,8 @@ public struct CompletionRequest {
         self.temperature = temperature
         self.topP = topP
         self.user = user
+        self.tools = tools
+        self.toolChoice = toolChoice
     }
 
     // MARK: - DTO Conversion
@@ -109,7 +119,9 @@ public struct CompletionRequest {
             stream: stream,
             temperature: temperature,
             topP: topP,
-            user: user
+            user: user,
+            tools: tools?.map { $0.toDTO() },
+            toolChoice: toolChoice?.toDTO()
         )
     }
 }
@@ -133,4 +145,59 @@ public extension CompletionRequest {
             }
         }
     }
+    
+    /// A tool that can be used by the model
+    struct Tool {
+        /// The type of the tool. Currently, only function is supported.
+        let type: String
+        let function: Function
+        
+        init(function: Function) {
+            self.type = "function"
+            self.function = function
+        }
+        
+        func toDTO() -> CompletionRequestDTO.Tool {
+            CompletionRequestDTO.Tool(function: function.toDTO())
+        }
+    }
+
+    /// A function that can be called by the model
+    struct Function {
+        /// The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
+        let name: String
+        /// A description of what the function does, used by the model to choose when and how to call the function.
+        let description: String?
+        /// The parameters the functions accepts, described as a JSON Schema object.
+        let parameters: [String: Any]?
+        /// Whether to enable strict schema adherence when generating the function call.
+        let strict: Bool?
+        
+        func toDTO() -> CompletionRequestDTO.Function {
+            CompletionRequestDTO.Function(
+                name: name,
+                description: description,
+                parameters: parameters,
+                strict: strict
+            )
+        }
+    }
+
+    /// Controls which (if any) function is called by the model.
+    enum ToolChoice {
+        case none
+        case auto
+        case function(name: String)
+        
+        func toDTO() -> CompletionRequestDTO.ToolChoice {
+            switch self {
+            case .none:
+                return .none
+            case .auto:
+                return .auto
+            case .function(let name):
+                return .function(name: name)
+            }
+        }
+    }
 }

Sources/CompilerSwiftAI/Network Models/CompletionRequestDTO.swift

@@ -66,6 +66,13 @@ struct CompletionRequestDTO: Encodable {
     /// A unique identifier representing your end user.
     let user: String?
 
+    /// Tools (including functions) that the model may call.
+    let tools: [Tool]?
+    
+    /// Controls which (if any) function is called by the model.
+    /// Can be "none", "auto", or a FunctionCall object.
+    let toolChoice: ToolChoice?
+
     // MARK: - Coding Keys
 
     enum CodingKeys: String, CodingKey {
@@ -80,6 +87,8 @@ struct CompletionRequestDTO: Encodable {
         case temperature
         case topP = "top_p"
         case user
+        case tools
+        case toolChoice = "tool_choice"
     }
 
     /// Initialize a new completion request with the given parameters.
@@ -99,7 +108,9 @@ struct CompletionRequestDTO: Encodable {
         stream: Bool? = false,
         temperature: Double? = 1,
         topP: Double? = 1,
-        user: String? = nil
+        user: String? = nil,
+        tools: [Tool]? = nil,
+        toolChoice: ToolChoice? = nil
     ) {
         self.messages = messages
         self.model = model
@@ -117,6 +128,8 @@ struct CompletionRequestDTO: Encodable {
         self.temperature = temperature
         self.topP = topP
         self.user = user
+        self.tools = tools
+        self.toolChoice = toolChoice
     }
 
     func copy(
@@ -135,7 +148,9 @@ struct CompletionRequestDTO: Encodable {
         stream: Bool? = nil,
         temperature: Double? = nil,
         topP: Double? = nil,
-        user: String? = nil
+        user: String? = nil,
+        tools: [Tool]? = nil,
+        toolChoice: ToolChoice? = nil
     ) -> CompletionRequestDTO {
         CompletionRequestDTO(
             messages: messages ?? self.messages,
@@ -153,7 +168,9 @@ struct CompletionRequestDTO: Encodable {
             stream: stream ?? self.stream,
             temperature: temperature ?? self.temperature,
             topP: topP ?? self.topP,
-            user: user ?? self.user
+            user: user ?? self.user,
+            tools: tools ?? self.tools,
+            toolChoice: toolChoice ?? self.toolChoice
         )
     }
 }
@@ -176,3 +193,72 @@ extension CompletionRequestDTO {
         }
     }
 }
+
+extension CompletionRequestDTO {
+    /// A tool that can be used by the model.
+    struct Tool: Encodable {
+        /// The type of the tool. Currently, only function is supported.
+        let type: String
+        let function: Function
+        
+        init(function: Function) {
+            self.type = "function"
+            self.function = function
+        }
+    }
+
+    /// A function that can be called by the model.
+    struct Function: Encodable {
+        /// The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
+        let name: String
+        /// A description of what the function does, used by the model to choose when and how to call the function.
+        let description: String?
+        /// The parameters the functions accepts, described as a JSON Schema object.
+        /// Omitting parameters defines a function with an empty parameter list.
+        let parameters: [String: Any]?
+        /// Whether to enable strict schema adherence when generating the function call.
+        /// If set to true, the model will follow the exact schema defined in the parameters field.
+        let strict: Bool?
+
+        enum CodingKeys: String, CodingKey {
+            case name, description, parameters, strict
+        }
+
+        func encode(to encoder: Encoder) throws {
+            var container = encoder.container(keyedBy: CodingKeys.self)
+            try container.encode(name, forKey: .name)
+            try container.encodeIfPresent(description, forKey: .description)
+            
+            // Encode parameters as raw JSON if provided
+            if let params = parameters {
+                let jsonData = try JSONSerialization.data(withJSONObject: params)
+                let jsonString = String(data: jsonData, encoding: .utf8) ?? "{}"
+                try container.encode(jsonString, forKey: .parameters)
+            }
+            
+            try container.encodeIfPresent(strict, forKey: .strict)
+        }
+    }
+
+    /// Controls which (if any) function is called by the model.
+    enum ToolChoice: Encodable {
+        case none
+        case auto
+        case function(name: String)
+
+        func encode(to encoder: Encoder) throws {
+            var container = encoder.singleValueContainer()
+            switch self {
+            case .none:
+                try container.encode("none")
+            case .auto:
+                try container.encode("auto")
+            case .function(let name):
+                let dict: [String: Any] = ["type": "function", "function": ["name": name]]
+                let jsonData = try JSONSerialization.data(withJSONObject: dict)
+                let jsonString = String(data: jsonData, encoding: .utf8) ?? "{}"
+                try container.encode(jsonString)
+            }
+        }
+    }
+}