validate message and batch

Author: fumito-ito

Sources/AnthropicSwiftSDK/ClientError.swift

@@ -35,6 +35,10 @@ public enum ClientError: Error {
     case failedToMakeEncodableToolUseInput([String: Any])
     /// SDK failed to encode `SystemPrompt` object
     case failedToEncodeSystemPrompt
+    /// These messages are not supported by the model.
+    case unsupportedMessageContentContained(model: Model, messages: [Message])
+    /// Some unsupported features are used.
+    case unsupportedFeatureUsed(description: String)
 
     /// Description of sdk internal errors.
     public var localizedDescription: String {
@@ -63,6 +67,10 @@ public enum ClientError: Error {
             return "Failed to make ToolUse.input object Encodable"
         case .failedToEncodeSystemPrompt:
             return "Failed to encode `SystemPrompt` object"
+        case let .unsupportedMessageContentContained(model, messages):
+            return "The model \(model.stringfy) does not support these messages: \(messages)"
+        case let .unsupportedFeatureUsed(description):
+            return "Some unsupported features are used. For more detail, see \(description)."
         }
     }
 }

Sources/AnthropicSwiftSDK/Entity/Model.swift

@@ -47,6 +47,50 @@ public enum Model {
     }
 }
 
+extension Model {
+    /// Whether this model supports Message Batches API or not.
+    ///
+    /// `Claude 3.0 Sonnet` does not support it.
+    var isSupportBatches: Bool {
+        switch self {
+        case
+            .claude_3_Opus,
+            .claude_3_Haiku,
+            .claude_3_5_Sonnet,
+            .claude_3_5_Haiku,
+            .custom:
+            return true
+        case .claude_3_Sonnet:
+            return false
+        }
+    }
+
+    /// Whether this model supports Vision feature or not.
+    ///
+    /// `Claude 3.5 Haiku` does not support it.
+    var isSupportVision: Bool {
+        switch self {
+        case
+            .claude_3_Opus,
+            .claude_3_Haiku,
+            .claude_3_Sonnet,
+            .claude_3_5_Sonnet,
+            .custom:
+            return true
+        case .claude_3_5_Haiku:
+            return false
+        }
+    }
+
+    func isValid(for message: Message) -> Bool {
+        if isSupportVision {
+            return true
+        }
+
+        return message.content.allSatisfy { $0.contentType != .image }
+    }
+}
+
 extension Model {
     var stringfy: String {
         switch self {

Sources/AnthropicSwiftSDK/MessageBatches.swift

@@ -31,7 +31,9 @@ public struct MessageBatches {
     /// - Returns: A `BatchResponse` containing the details of the created batches.
     /// - Throws: An error if the request fails.
     public func createBatches(batches: [MessageBatch]) async throws -> BatchResponse {
-        try await createBatches(
+        try validate(batches: batches)
+
+        return try await createBatches(
             batches: batches,
             anthropicHeaderProvider: DefaultAnthropicHeaderProvider(),
             authenticationHeaderProvider: APIKeyAuthenticationHeaderProvider(apiKey: apiKey)
@@ -336,3 +338,22 @@ public struct MessageBatches {
         return try anthropicJSONDecoder.decode(BatchResponse.self, from: data)
     }
 }
+
+extension MessageBatches {
+    func validate(batches: [MessageBatch]) throws {
+        try batches.forEach { batch in
+            let model = batch.parameter.model
+            guard model.isSupportBatches else {
+                throw ClientError.unsupportedFeatureUsed(description: "The model: \(model.stringfy) does not support Message Batches API")
+            }
+
+            let messages = batch.parameter.messages
+            guard (messages.allSatisfy { model.isValid(for: $0) }) else {
+                throw ClientError.unsupportedMessageContentContained(
+                    model: model,
+                    messages: messages.filter { model.isValid(for: $0) == false }
+                )
+            }
+        }
+    }
+}

Sources/AnthropicSwiftSDK/Messages.swift

@@ -45,7 +45,9 @@ public struct Messages {
         tools: [Tool]? = nil,
         toolChoice: ToolChoice = .auto
     ) async throws -> MessagesResponse {
-        try await createMessage(
+        try validate(model, for: messages)
+
+        return try await createMessage(
             messages,
             model: model,
             system: system,
@@ -160,7 +162,9 @@ public struct Messages {
         tools: [Tool]? = nil,
         toolChoice: ToolChoice = .auto
     ) async throws -> AsyncThrowingStream<StreamingResponse, Error> {
-        try await streamMessage(
+        try validate(model, for: messages)
+
+        return try await streamMessage(
             messages,
             model: model,
             system: system,
@@ -246,3 +250,14 @@ public struct Messages {
         return try await AnthropicStreamingParser.parse(stream: data.lines).accumulated()
     }
 }
+
+extension Messages {
+    func validate(_ model: Model, for messages: [Message]) throws {
+        guard (messages.allSatisfy { model.isValid(for: $0) }) else {
+            throw ClientError.unsupportedMessageContentContained(
+                model: model,
+                messages: messages.filter { model.isValid(for: $0) == false }
+            )
+        }
+    }
+}