refactor: renames generateEmbeddings to embeddings (#16)

Sources/OllamaKit/OllamaKit+Embeddings.swift

@@ -0,0 +1,60 @@
+//
+//  OllamaKit+Embeddings.swift
+//
+//
+//  Created by Paul Thrasher on 02/09/24.
+//
+
+import Alamofire
+import Combine
+import Foundation
+
+extension OllamaKit {
+    /// Asynchronously generates embeddings from a specific model from the Ollama API.
+    ///
+    /// This method accepts ``OKEmbeddingsRequestData`` and returns an ``OKEmbeddingsResponse`` containing embeddings from the requested model.
+    ///
+    /// ```swift
+    /// let ollamaKit = OllamaKit()
+    /// let requestData = OKEmbeddingsRequestData(/* parameters */)
+    /// let embeddings = try await ollamaKit.embeddings(data: requestData)
+    /// ```
+    ///
+    /// - Parameter data: The ``OKEmbeddingsRequestData`` used to query the API for generating specific model embeddings.
+    /// - Returns: An ``OKEmbeddingsResponse`` containing the embeddings from the model.
+    /// - Throws: An error if the request fails or the response can't be decoded.
+    public func embeddings(data: OKEmbeddingsRequestData) async throws -> OKEmbeddingsResponse {
+        let request = AF.request(router.embeddings(data: data)).validate()
+        let response = request.serializingDecodable(OKEmbeddingsResponse.self, decoder: decoder)
+        let value = try await response.value
+
+        return value
+    }
+
+    /// Retrieves embeddings from a specific model from the Ollama API as a Combine publisher.
+    ///
+    /// This method provides a reactive approach to generate embeddings. It accepts ``OKEmbeddingsRequestData`` and returns a Combine publisher that emits an ``OKEmbeddingsResponse`` upon successful retrieval.
+    ///
+    /// ```swift
+    /// let ollamaKit = OllamaKit()
+    /// let requestData = OKEmbeddingsRequestData(/* parameters */)
+    ///
+    /// ollamaKit.embeddings(data: requestData)
+    ///     .sink(receiveCompletion: { completion in
+    ///         // Handle completion
+    ///     }, receiveValue: { response in
+    ///         // Handle the received embeddings response
+    ///     })
+    ///     .store(in: &cancellables)
+    /// ```
+    ///
+    /// - Parameter data: The ``OKEmbeddingsRequestData`` used to query the API for embeddings from a specific model.
+    /// - Returns: A `AnyPublisher<OKEmbeddingsResponse, AFError>` that emits embeddings.
+    public func embeddings(data: OKEmbeddingsRequestData) -> AnyPublisher<OKEmbeddingsResponse, AFError> {
+        let request = AF.request(router.embeddings(data: data)).validate()
+
+        return request
+            .publishDecodable(type: OKEmbeddingsResponse.self, decoder: decoder).value()
+            .eraseToAnyPublisher()
+    }
+}

Sources/OllamaKit/RequestData/OKGenerateEmbeddingsRequestData.swift → Sources/OllamaKit/RequestData/OKEmbeddingsRequestData.swift

@@ -1,5 +1,5 @@
 //
-//  OKGenerateEmbeddingsRequestData.swift
+//  OKEmbeddingsRequestData.swift
 //
 //
 //  Created by Paul Thrasher on 02/09/24.
@@ -8,7 +8,7 @@
 import Foundation
 
 /// A structure that encapsulates the data required for generating embeddings using the Ollama API.
-public struct OKGenerateEmbeddingsRequestData: Encodable {
+public struct OKEmbeddingsRequestData: Encodable {
     /// A string representing the identifier of the model.
     public let model: String
 

Sources/OllamaKit/RequestData/OKGenerateRequestData.swift

@@ -23,8 +23,8 @@ public struct OKGenerateRequestData: Encodable {
     /// An optional string specifying the system message.
     public var system: String?
 
-    /// An optional array of integers representing contextual information.
-    public var context: [Int]?
+    /// An optional array of doubles representing contextual information.
+    public var context: [Double]?
 
     /// Optional ``OKCompletionOptions`` providing additional configuration for the generation request.
     public var options: OKCompletionOptions?

Sources/OllamaKit/Responses/OKEmbeddingsResponse.swift

@@ -0,0 +1,15 @@
+//
+//  OKEmbeddingsResponse.swift
+//
+//
+//  Created by Paul Thrasher on 02/09/24.
+//
+
+import Foundation
+
+/// A structure that represents the response to an embedding request from the Ollama API.
+public struct OKEmbeddingsResponse: Decodable {
+
+    /// An array of doubles representing the embeddings of the input prompt.
+    public let embedding: [Double]?
+}

Sources/OllamaKit/Responses/OKGenerateResponse.swift

@@ -18,8 +18,8 @@ public struct OKGenerateResponse: OKCompletionResponse, Decodable {
     /// A string containing the generated content.
     public let response: String
 
-    /// An optional array of integers representing contextual information used in the generation.
-    public let context: [Int]?
+    /// An optional array of doubles representing contextual information used in the generation.
+    public let context: [Double]?
 
     /// A boolean indicating whether the generation process is complete.
     public let done: Bool

Sources/OllamaKit/Utils/OKRouter.swift

@@ -18,7 +18,7 @@ internal enum OKRouter {
     case chat(data: OKChatRequestData)
     case copyModel(data: OKCopyModelRequestData)
     case deleteModel(data: OKDeleteModelRequestData)
-    case generateEmbeddings(data: OKGenerateEmbeddingsRequestData)
+    case embeddings(data: OKEmbeddingsRequestData)
 
     internal var path: String {
         switch self {
@@ -36,7 +36,7 @@ internal enum OKRouter {
             return "/api/copy"
         case .deleteModel:
             return "/api/delete"
-        case .generateEmbeddings:
+        case .embeddings:
             return "/api/embeddings"
         }
     }
@@ -57,7 +57,7 @@ internal enum OKRouter {
             return .post
         case .deleteModel:
             return .delete
-        case .generateEmbeddings:
+        case .embeddings:
             return .post
         }
     }
@@ -85,7 +85,7 @@ extension OKRouter: URLRequestConvertible {
             request.httpBody = try JSONEncoder.default.encode(data)
         case .deleteModel(let data):
             request.httpBody = try JSONEncoder.default.encode(data)
-        case .generateEmbeddings(let data):
+        case .embeddings(let data):
             request.httpBody = try JSONEncoder.default.encode(data)
         default:
             break

Tests/OllamaKitTests/OllamaKitTests.swift

@@ -51,7 +51,7 @@ final class OllamaKitTests: XCTestCase {
 
     }
 
-    func testGenerateEmbeddingsFailure() async throws {
+    func testEmbeddingsFailure() async throws {
 
     }
 }