Merge pull request #12 from Chamepp/main

feat: getting the api key by using dependency and leveraging the SearchOptions from the developer

Author: Chamepp

Sources/SearchMind/Internal/SearchEngine.swift

@@ -474,14 +474,17 @@ struct PatternMatchAlgorithm: SearchAlgorithm {
 struct GPTSemanticSearchAlgorithm: SearchAlgorithm {
     func search(term: String, type _: SearchType, options: SearchOptions) async throws -> [SearchMind.SearchResult] {
         let searchTerm = options.caseSensitive ? term : term.lowercased()
-        let termEmbedding = try await embed(text: searchTerm)
+        guard let apiKey = options.apiKey else {
+            throw SearchError.missingKey
+        }
+        let termEmbedding = try await embed(text: searchTerm, apiKey: apiKey)
 
         let files = try await getFilesToSearch(options: options)
         var results: [SearchMind.SearchResult] = []
 
         for fileURL in files {
             let content = try String(contentsOf: fileURL)
-            let fileEmbedding = try await embed(text: content)
+            let fileEmbedding = try await embed(text: content, apiKey: apiKey)
 
             let similarity = cosineSimilarity(termEmbedding, fileEmbedding)
             if similarity > 0.4 {
@@ -499,10 +502,7 @@ struct GPTSemanticSearchAlgorithm: SearchAlgorithm {
             .map { $0 }
     }
 
-    private func embed(text: String) async throws -> [Double] {
-        guard let apiKey = ProcessInfo.processInfo.environment["OPENAI_API_KEY"] else {
-            throw SearchError.missingKey
-        }
+    private func embed(text: String, apiKey: String) async throws -> [Double] {
         let request = EmbeddingRequest(model: "text-embedding-ada-002", input: [text])
         let jsonData = try JSONEncoder().encode(request)
 

Sources/SearchMind/SearchMind.swift

@@ -369,6 +369,21 @@ public struct SearchOptions: Sendable {
     /// ```
     public let caseSensitive: Bool
 
+    /// A required API key for enabling AI-powered search algorithms, such as GPT-based semantic search.
+    ///
+    /// This key must be provided when using any search strategy that relies on external AI services.
+    /// If the key is missing and an AI-based algorithm is selected (e.g., `GPTSemanticSearchAlgorithm`),
+    /// an error will be thrown or the search will fail.
+    ///
+    /// - Important: This is mandatory for semantic searches. Omitting it while using AI algorithms
+    /// will result in runtime errors or degraded functionality.
+    ///
+    /// - Example:
+    /// ```swift
+    /// let options = SearchOptions(apiKey: "sk-...")
+    /// ```
+    public let apiKey: String?
+
     /// Enables approximate (fuzzy) matching for file name searches
     ///
     /// When `true` (default), file name searches will use Levenshtein distance
@@ -464,6 +479,7 @@ public struct SearchOptions: Sendable {
     /// - Returns: A configured SearchOptions instance
     public init(
         caseSensitive: Bool = false,
+        apiKey: String? = ProcessInfo.processInfo.environment["OPENAI_API_KEY"],
         fuzzyMatching: Bool = true,
         semantic: Bool = false,
         patternMatch: Bool = false,
@@ -473,6 +489,7 @@ public struct SearchOptions: Sendable {
         timeout: TimeInterval? = nil
     ) {
         self.caseSensitive = caseSensitive
+        self.apiKey = apiKey
         self.fuzzyMatching = fuzzyMatching
         self.semantic = semantic
         self.patternMatch = patternMatch