feat: add new models for gemini translation

Easydict.xcodeproj/project.pbxproj

@@ -3577,7 +3577,7 @@
 			repositoryURL = "https://github.com/google/generative-ai-swift";
 			requirement = {
 				kind = upToNextMajorVersion;
-				minimumVersion = 0.4.4;
+				minimumVersion = 0.5.3;
 			};
 		};
 		03022F1A2B35DEBA00B63209 /* XCRemoteSwiftPackageReference "Hue" */ = {

Easydict/App/Localizable.xcstrings

@@ -2410,18 +2410,18 @@
         }
       }
     },
-    "service.configuration.gemini.api_key.title" : {
+    "service.configuration.gemini.api_key.placeholder" : {
       "localizations" : {
         "en" : {
           "stringUnit" : {
             "state" : "translated",
-            "value" : "API Key"
+            "value" : "xxxxxxxxxxxxx"
           }
         },
         "zh-Hans" : {
           "stringUnit" : {
             "state" : "translated",
-            "value" : "API Key"
+            "value" : "xxxxxxxxxxxxx"
           }
         }
       }

Easydict/Swift/Feature/Configuration/Configuration+Defaults.swift

@@ -221,7 +221,7 @@ extension Defaults.Keys {
         sentenceStoredKey(.openAI),
         default: "1"
     )
-    static let openAIServiceUsageStatus = Key<OpenAIUsageStatus>(
+    static let openAIServiceUsageStatus = Key<ServiceUsageStatus>(
         serviceUsageStatusStoredKey(.openAI),
         default: .default
     )
@@ -254,7 +254,7 @@ extension Defaults.Keys {
         sentenceStoredKey(.customOpenAI),
         default: "0"
     )
-    static let customOpenAIServiceUsageStatus = Key<OpenAIUsageStatus>(
+    static let customOpenAIServiceUsageStatus = Key<ServiceUsageStatus>(
         serviceUsageStatusStoredKey(.builtInAI),
         default: .default
     )
@@ -280,7 +280,7 @@ extension Defaults.Keys {
         sentenceStoredKey(.builtInAI),
         default: "0"
     )
-    static let builtInAIServiceUsageStatus = Key<OpenAIUsageStatus>(
+    static let builtInAIServiceUsageStatus = Key<ServiceUsageStatus>(
         serviceUsageStatusStoredKey(.builtInAI),
         default: .default
     )
@@ -311,7 +311,32 @@ extension Defaults.Keys {
     static let aliAccessKeySecret = Key<String?>(EZAliAccessKeySecret)
 
     // Gemni
-    static let geminiAPIKey = Key<String?>(EZGeminiAPIKey)
+    static let geminiAPIKey = Key<String?>("EZGeminiAPIKey")
+    static let geminiTranslation = Key<String>(
+        translationStoredKey(.gemini),
+        default: "1"
+    )
+    static let geminiDictionary = Key<String>(
+        dictionaryStoredKey(.gemini),
+        default: "1"
+    )
+    static let geminiSentence = Key<String>(
+        sentenceStoredKey(.gemini),
+        default: "1"
+    )
+    static let geminiServiceUsageStatus = Key<ServiceUsageStatus>(
+        serviceUsageStatusStoredKey(.gemini),
+        default: .default
+    )
+    static let geminiModel = Key<String>("geminiModel", default: GeminiModel.gemini1_5_flash.rawValue)
+    static let geminiAvailableModels = Key<String?>(
+        "geminiAvailableModels",
+        default: GeminiModel.allCases.map { $0.rawValue }.joined(separator: ",")
+    )
+    static let geminiValidModels = Key<Array>(
+        "geminiValidModels",
+        default: GeminiModel.allCases.map { $0.rawValue }
+    )
 }
 
 /// shortcut

Easydict/Swift/Service/Gemini/GeminiService.swift

@@ -10,7 +10,6 @@ import Defaults
 import Foundation
 import GoogleGenerativeAI
 
-// TODO: add a LLM stream service base class, make both OpenAI and Gemini inherit from it.
 @objc(EZGeminiService)
 public final class GeminiService: LLMStreamService {
     // MARK: Public
@@ -27,10 +26,6 @@ public final class GeminiService: LLMStreamService {
         NSLocalizedString("gemini_translate", comment: "The name of Gemini Translate")
     }
 
-    override public func queryTextType() -> EZQueryTextType {
-        [.translation]
-    }
-
     override public func translate(
         _ text: String,
         from: Language,
@@ -39,27 +34,28 @@ public final class GeminiService: LLMStreamService {
     ) {
         Task {
             do {
-                let translationPrompt = translationPrompt(text: text, from: from, to: to)
-                let prompt = LLMStreamService.translationSystemPrompt +
-                    "\n" + translationPrompt
+                result.isStreamFinished = false
+
+                let queryType = queryType(text: text, from: from, to: to)
+                let translationPrompt = promptContent(queryType: queryType, text: text, from: from, to: to)
+                let systemInstruction = LLMStreamService.translationSystemPrompt
                 let model = GenerativeModel(
-                    name: "gemini-pro",
+                    name: model,
                     apiKey: apiKey,
                     safetySettings: [
                         harassmentBlockNone,
                         hateSpeechBlockNone,
                         sexuallyExplicitBlockNone,
                         dangerousContentBlockNone,
-                    ]
+                    ],
+                    systemInstruction: systemInstruction
                 )
 
-                result.isStreamFinished = false
-
                 var resultString = ""
 
                 // Gemini Docs: https://github.com/google/generative-ai-swift
 
-                let outputContentStream = model.generateContentStream(prompt)
+                let outputContentStream = model.generateContentStream(translationPrompt)
                 for try await outputContent in outputContentStream {
                     guard let line = outputContent.text else {
                         return
@@ -69,9 +65,12 @@ public final class GeminiService: LLMStreamService {
 
                         result.translatedResults = [resultString]
                         await MainActor.run {
-                            throttler.throttle { [unowned self] in
-                                completion(result, nil)
-                            }
+                            handleResult(
+                                queryType: queryType,
+                                resultString: concatenateStrings(from: result.translatedResults ?? []),
+                                error: nil,
+                                completion: completion
+                            )
                         }
                     }
                 }
@@ -123,11 +122,116 @@ public final class GeminiService: LLMStreamService {
         Defaults[.geminiAPIKey] ?? ""
     }
 
+    override var availableModels: [String] {
+        Defaults[.geminiValidModels]
+    }
+
+    override var model: String {
+        get {
+            Defaults[.geminiModel]
+        }
+        set {
+            // easydict://writeKeyValue?EZGeminiModelKey=gemini-1.5-flash
+            Defaults[.geminiModel] = newValue
+        }
+    }
+
     // MARK: Private
 
     // Set Gemini safety level to BLOCK_NONE
     private let harassmentBlockNone = SafetySetting(harmCategory: .harassment, threshold: .blockNone)
     private let hateSpeechBlockNone = SafetySetting(harmCategory: .hateSpeech, threshold: .blockNone)
     private let sexuallyExplicitBlockNone = SafetySetting(harmCategory: .sexuallyExplicit, threshold: .blockNone)
     private let dangerousContentBlockNone = SafetySetting(harmCategory: .dangerousContent, threshold: .blockNone)
+
+    private func promptContent(
+        queryType: EZQueryTextType,
+        text: String,
+        from sourceLanguage: Language,
+        to targetLanguage: Language
+    )
+        -> [ModelContent] {
+        var prompts = [[String: String]]()
+
+        switch queryType {
+        case .dictionary:
+            prompts = dictMessages(word: text, sourceLanguage: sourceLanguage, targetLanguage: targetLanguage)
+        case .sentence:
+            prompts = sentenceMessages(sentence: text, from: sourceLanguage, to: targetLanguage)
+        case .translation:
+            fallthrough
+        default:
+            prompts = translationMessages(text: text, from: sourceLanguage, to: targetLanguage)
+        }
+
+        var chats: [ModelContent] = []
+        for prompt in prompts {
+            if let roleRaw = prompt["role"],
+               let parts = prompt["content"] {
+                let role = getCorrectParts(from: roleRaw)
+                let chat = ModelContent(role: role, parts: parts)
+                chats.append(chat)
+            }
+        }
+        guard !chats.isEmpty else {
+            return chats
+        }
+        // removing first element in [ModelContent] since it's system instruction
+        chats.removeFirst()
+        return chats
+    }
+
+    /// Given a roleRaw, replace "assistant" with "model"
+    private func getCorrectParts(from roleRaw: String) -> String {
+        if roleRaw.lowercased() == "assistant" {
+            "model"
+        } else {
+            roleRaw
+        }
+    }
+
+    private func handleResult(
+        queryType: EZQueryTextType,
+        resultString: String?,
+        error: Error?,
+        completion: @escaping (EZQueryResult, Error?) -> ()
+    ) {
+        var normalResults: [String]?
+        if let resultString {
+            normalResults = [resultString.trim()]
+        }
+
+        result.isStreamFinished = error != nil
+        result.translatedResults = normalResults
+        let updateCompletion = {
+            self.throttler.throttle { [unowned self] in
+                completion(result, error)
+            }
+        }
+
+        switch queryType {
+        case .sentence, .translation:
+            updateCompletion()
+
+        case .dictionary:
+            if error != nil {
+                result.showBigWord = false
+                result.translateResultsTopInset = 0
+                updateCompletion()
+                return
+            }
+
+            result.showBigWord = true
+            result.queryText = queryModel.queryText
+            result.translateResultsTopInset = 6
+            updateCompletion()
+
+        default:
+            updateCompletion()
+        }
+    }
+
+    private func concatenateStrings(from array: [String]) -> String {
+        array.joined()
+    }
 }

Easydict/Swift/Service/OpenAI/LLMStreamService.swift

@@ -6,6 +6,7 @@
 //  Copyright © 2024 izual. All rights reserved.
 //
 
+import Defaults
 import Foundation
 
 // MARK: - LLMStreamService
@@ -131,3 +132,42 @@ public class LLMStreamService: QueryService {
         return .translation
     }
 }
+
+// MARK: - ServiceUsageStatus
+
+enum ServiceUsageStatus: String, CaseIterable {
+    case `default` = "0"
+    case alwaysOff = "1"
+    case alwaysOn = "2"
+}
+
+// MARK: EnumLocalizedStringConvertible
+
+extension ServiceUsageStatus: EnumLocalizedStringConvertible {
+    var title: String {
+        switch self {
+        case .default:
+            NSLocalizedString(
+                "service.configuration.openai.usage_status_default.title",
+                bundle: .main,
+                comment: ""
+            )
+        case .alwaysOff:
+            NSLocalizedString(
+                "service.configuration.openai.usage_status_always_off.title",
+                bundle: .main,
+                comment: ""
+            )
+        case .alwaysOn:
+            NSLocalizedString(
+                "service.configuration.openai.usage_status_always_on.title",
+                bundle: .main,
+                comment: ""
+            )
+        }
+    }
+}
+
+// MARK: Defaults.Serializable
+
+extension ServiceUsageStatus: Defaults.Serializable {}

Easydict/Swift/View/SettingView/Tabs/ServiceConfigurationView/QueryService+ConfigurableService/BuiltInAIService+ConfigurableService.swift

@@ -31,7 +31,7 @@ extension BuiltInAIService: ConfigurableService {
             ServiceConfigurationPickerCell(
                 titleKey: "service.configuration.openai.usage_status.title",
                 key: .builtInAIServiceUsageStatus,
-                values: OpenAIUsageStatus.allCases
+                values: ServiceUsageStatus.allCases
             )
         }
     }

Easydict/Swift/View/SettingView/Tabs/ServiceConfigurationView/QueryService+ConfigurableService/CustomOpenAIService+ConfigurableService.swift

@@ -89,7 +89,7 @@ private struct CustomOpenAIServiceConfigurationView: View {
             ServiceConfigurationPickerCell(
                 titleKey: "service.configuration.openai.usage_status.title",
                 key: .customOpenAIServiceUsageStatus,
-                values: OpenAIUsageStatus.allCases
+                values: ServiceUsageStatus.allCases
             )
         }
         .onDisappear {