feat: add new models for gemini translation

Easydict.xcodeproj/project.pbxproj

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

Easydict.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -77,8 +77,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/google/generative-ai-swift",
       "state" : {
-        "revision" : "dcbdb5e591e1aa2bb68851dc7515f6b0a59026cd",
-        "version" : "0.4.7"
+        "revision" : "5d750b80651da9721c37c5eb1fc0b6750d1884d3",
+        "version" : "0.5.3"
       }
     },
     {

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"
+            "state" : "needs_review",
+            "value" : "xxxxxxxxxxxxx"
           }
         }
       }

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

@@ -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<GeminiUsageStatus>(
+        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 geminiVaildModels = Key<Array>(
+        "geminiVaildModels",
+        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
@@ -28,7 +27,7 @@ public final class GeminiService: LLMStreamService {
     }
 
     override public func queryTextType() -> EZQueryTextType {
-        [.translation]
+        [.translation, .dictionary, .sentence]
     }
 
     override public func translate(
@@ -39,11 +38,14 @@ public final class GeminiService: LLMStreamService {
     ) {
         Task {
             do {
+                result.from = from
+                result.to = to
+                result.isStreamFinished = false
                 let translationPrompt = translationPrompt(text: text, from: from, to: to)
                 let prompt = LLMStreamService.translationSystemPrompt +
                     "\n" + translationPrompt
                 let model = GenerativeModel(
-                    name: "gemini-pro",
+                    name: model,
                     apiKey: apiKey,
                     safetySettings: [
                         harassmentBlockNone,
@@ -53,8 +55,6 @@ public final class GeminiService: LLMStreamService {
                     ]
                 )
 
-                result.isStreamFinished = false
-
                 var resultString = ""
 
                 // Gemini Docs: https://github.com/google/generative-ai-swift
@@ -123,6 +123,20 @@ public final class GeminiService: LLMStreamService {
         Defaults[.geminiAPIKey] ?? ""
     }
 
+    override var availableModels: [String] {
+        Defaults[.geminiVaildModels]
+    }
+
+    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

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

@@ -6,16 +6,232 @@
 //  Copyright © 2024 izual. All rights reserved.
 //
 
+import Combine
+import Defaults
 import Foundation
 import SwiftUI
 
+// MARK: - GeminiService + ConfigurableService
+
 extension GeminiService: ConfigurableService {
     func configurationListItems() -> some View {
-        ServiceConfigurationSecretSectionView(service: self, observeKeys: [.geminiAPIKey]) {
+        GeminiServiceConfigurationView(service: self)
+    }
+}
+
+// MARK: - GeminiServiceConfigurationView
+
+private struct GeminiServiceConfigurationView: View {
+    // MARK: Lifecycle
+
+    init(service: GeminiService) {
+        self.service = service
+        self.viewModel = GeminiViewModel(service: service)
+    }
+
+    // MARK: Internal
+
+    let service: GeminiService
+
+    var body: some View {
+        ServiceConfigurationSecretSectionView(
+            service: service,
+            observeKeys: [.geminiAPIKey, .geminiAvailableModels]
+        ) {
             ServiceConfigurationSecureInputCell(
-                textFieldTitleKey: "service.configuration.gemini.api_key.title",
-                key: .geminiAPIKey
+                textFieldTitleKey: "service.configuration.openai.api_key.title",
+                key: .geminiAPIKey,
+                placeholder: "service.configuration.gemini.api_key.placeholder"
+            )
+            // supported models
+            TextField(
+                "service.configuration.custom_openai.supported_models.title",
+                text: viewModel.$availableModels ?? "",
+                prompt: Text("service.configuration.custom_openai.model.placeholder")
+            )
+            .padding(10.0)
+            Picker(
+                "service.configuration.openai.model.title",
+                selection: viewModel.$model
+            ) {
+                ForEach(viewModel.validModels, id: \.self) { value in
+                    Text(value)
+                }
+            }
+            .padding(10.0)
+
+            ServiceConfigurationToggleCell(
+                titleKey: "service.configuration.openai.translation.title",
+                key: .geminiTranslation
+            )
+            ServiceConfigurationToggleCell(
+                titleKey: "service.configuration.openai.sentence.title",
+                key: .geminiSentence
+            )
+            ServiceConfigurationToggleCell(
+                titleKey: "service.configuration.openai.dictionary.title",
+                key: .geminiDictionary
+            )
+            ServiceConfigurationPickerCell(
+                titleKey: "service.configuration.openai.usage_status.title",
+                key: .geminiServiceUsageStatus,
+                values: GeminiUsageStatus.allCases
+            )
+        }
+        .onDisappear {
+            viewModel.invalidate()
+        }
+    }
+
+    // MARK: Private
+
+    @ObservedObject private var viewModel: GeminiViewModel
+}
+
+// MARK: - GeminiViewModel
+
+private class GeminiViewModel: ObservableObject {
+    // MARK: Lifecycle
+
+    init(service: GeminiService) {
+        self.service = service
+        Defaults.publisher(.geminiModel, options: [])
+            .removeDuplicates()
+            .sink { _ in
+                self.modelChanged()
+            }
+            .store(in: &cancellables)
+        Defaults.publisher(.geminiAvailableModels)
+            .removeDuplicates()
+            .throttle(for: 0.1, scheduler: DispatchQueue.main, latest: true)
+            .sink { _ in
+                self.modelsTextChanged()
+            }
+            .store(in: &cancellables)
+    }
+
+    // MARK: Internal
+
+    let service: GeminiService
+
+    @Default(.geminiModel) var model
+    @Default(.geminiAvailableModels) var availableModels
+
+    @Published var validModels: [String] = []
+
+    func invalidate() {
+        cancellables.forEach { $0.cancel() }
+        cancellables.removeAll()
+    }
+
+    // MARK: Private
+
+    private var cancellables: Set<AnyCancellable> = []
+
+    private func modelChanged() {
+        if !validModels.contains(model) {
+            if model.isEmpty {
+                availableModels = ""
+            } else {
+                if availableModels?.isEmpty == true {
+                    availableModels = model
+                } else {
+                    availableModels = /* "\(model), "  + */ availableModels ?? ""
+                }
+            }
+        }
+        serviceConfigChanged()
+    }
+
+    private func modelsTextChanged() {
+        guard let availableModels else { return }
+
+        validModels = availableModels.components(separatedBy: ",")
+            .map { $0.trim() }.filter { !$0.isEmpty }
+
+        if validModels.isEmpty {
+            model = ""
+        } else if !validModels.contains(model) {
+            model = validModels[0]
+        }
+
+        Defaults[.geminiVaildModels] = validModels
+    }
+
+    private func serviceConfigChanged() {
+        objectWillChange.send()
+
+        let userInfo: [String: Any] = [
+            EZWindowTypeKey: service.windowType.rawValue,
+            EZServiceTypeKey: service.serviceType().rawValue,
+        ]
+        let notification = Notification(name: .serviceHasUpdated, object: nil, userInfo: userInfo)
+        NotificationCenter.default.post(notification)
+    }
+}
+
+// MARK: - GeminiModel
+
+// swiftlint:disable identifier_name
+enum GeminiModel: String, CaseIterable {
+    // Docs: https://ai.google.dev/gemini-api/docs/models/gemini
+
+    // RPM: Requests per minute, TPM: Tokens per minute
+    // RPD: Requests per day, TPD: Tokens per day
+    case gemini1_0_pro = "gemini-1.0-pro" // Free 15 RPM/32,000 TPM, 1,500 RPD/46,080,000 TPD (n/a context length)
+    case gemini1_5_flash = "gemini-1.5-flash" // Free 15 RPM/100million TPM, 1500 RPD/ n/a TPD  (1048k context length)
+    case gemini1_5_pro = "gemini-1.5-pro" // Free 2 RPM/32,000 TPM, 50 RPD/46,080,000 TPD (1048k context length)
+}
+
+// MARK: EnumLocalizedStringConvertible
+
+// swiftlint:enable identifier_name
+
+extension GeminiModel: EnumLocalizedStringConvertible {
+    var title: String {
+        rawValue
+    }
+}
+
+// MARK: Defaults.Serializable
+
+extension GeminiModel: Defaults.Serializable {}
+
+// MARK: - GeminiUsageStatus
+
+enum GeminiUsageStatus: String, CaseIterable {
+    case `default` = "0"
+    case alwaysOff = "1"
+    case alwaysOn = "2"
+}
+
+// MARK: EnumLocalizedStringConvertible
+
+extension GeminiUsageStatus: EnumLocalizedStringConvertible {
+    var title: String { // Use same xcstring with openai for title
+        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 GeminiUsageStatus: Defaults.Serializable {}